(shr-make-table): Tweak table generation.
[gnus] / lisp / gnus-xmas.el
1 ;;; gnus-xmas.el --- Gnus functions for XEmacs
2
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;;   2005, 2006, 2008, 2009, 2010 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 3, 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   (autoload 'gnus-active "gnus" nil nil 'macro)
32   (autoload 'gnus-group-entry "gnus" nil nil 'macro)
33   (autoload 'gnus-info-level "gnus" nil nil 'macro)
34   (autoload 'gnus-info-marks "gnus" nil nil 'macro)
35   (autoload 'gnus-info-method "gnus" nil nil 'macro)
36   (autoload 'gnus-info-score "gnus" nil nil 'macro))
37
38 (require 'text-props)
39 (defvar menu-bar-mode (featurep 'menubar))
40 (require 'messagexmas)
41 (require 'wid-edit)
42 (require 'gnus-util)
43
44 (defgroup gnus-xmas nil
45   "XEmacsoid support for Gnus"
46   :group 'gnus)
47
48 (defcustom gnus-xmas-glyph-directory nil
49   "Directory where Gnus logos and icons are located.
50 If this variable is nil, Gnus will try to locate the directory
51 automatically."
52   :type '(choice (const :tag "autodetect" nil)
53                  directory)
54   :group 'gnus-xmas)
55
56 (unless gnus-xmas-glyph-directory
57   (unless (setq gnus-xmas-glyph-directory
58                 (message-xmas-find-glyph-directory "gnus"))
59     (error "Can't find glyph directory. \
60 Possibly the `etc' directory has not been installed.")))
61
62 ;;; Internal variables.
63
64 ;; Don't warn about these undefined variables.
65
66 ;;defined in gnus.el
67 (defvar gnus-active-hashtb)
68 (defvar gnus-article-buffer)
69 (defvar gnus-auto-center-summary)
70 (defvar gnus-current-headers)
71 (defvar gnus-level-killed)
72 (defvar gnus-level-zombie)
73 (defvar gnus-newsgroup-bookmarks)
74 (defvar gnus-newsgroup-dependencies)
75 (defvar gnus-newsgroup-selected-overlay)
76 (defvar gnus-newsrc-hashtb)
77 (defvar gnus-read-mark)
78 (defvar gnus-refer-article-method)
79 (defvar gnus-reffed-article-number)
80 (defvar gnus-unread-mark)
81 (defvar gnus-version)
82 (defvar gnus-view-pseudos)
83 (defvar gnus-view-pseudos-separately)
84 (defvar gnus-visual)
85 (defvar gnus-zombie-list)
86 ;;defined in gnus-msg.el
87 (defvar gnus-article-copy)
88 (defvar gnus-check-before-posting)
89 ;;defined in gnus-vis.el
90 (defvar gnus-article-button-face)
91 (defvar gnus-article-mouse-face)
92 (defvar gnus-summary-selected-face)
93 (defvar gnus-group-reading-menu)
94 (defvar gnus-group-group-menu)
95 (defvar gnus-group-misc-menu)
96 (defvar gnus-summary-article-menu)
97 (defvar gnus-summary-thread-menu)
98 (defvar gnus-summary-misc-menu)
99 (defvar gnus-summary-post-menu)
100 (defvar gnus-summary-kill-menu)
101 (defvar gnus-article-article-menu)
102 (defvar gnus-article-treatment-menu)
103 (defvar gnus-mouse-2)
104 (defvar standard-display-table)
105 (defvar gnus-tree-minimize-window)
106 ;;`gnus-agent-mode' in gnus-agent.el will define it.
107 (defvar gnus-agent-summary-mode)
108 (defvar gnus-draft-mode)
109
110 (defun gnus-xmas-highlight-selected-summary ()
111   ;; Highlight selected article in summary buffer
112   (when gnus-summary-selected-face
113     (when gnus-newsgroup-selected-overlay
114       (delete-extent gnus-newsgroup-selected-overlay))
115     (setq gnus-newsgroup-selected-overlay
116           (make-extent (point-at-bol) (point-at-eol)))
117     (set-extent-face gnus-newsgroup-selected-overlay
118                      gnus-summary-selected-face)))
119
120 (defcustom gnus-xmas-force-redisplay nil
121   "*If non-nil, force a redisplay before recentering the summary buffer.
122 This is ugly, but it works around a bug in `window-displayed-height'."
123   :type 'boolean
124   :group 'gnus-xmas)
125
126 (defun gnus-xmas-switch-horizontal-scrollbar-off ()
127   (when (featurep 'scrollbar)
128     (set-specifier scrollbar-height (cons (current-buffer) 0))))
129
130 (defun gnus-xmas-summary-recenter ()
131   "\"Center\" point in the summary window.
132 If `gnus-auto-center-summary' is nil, or the article buffer isn't
133 displayed, no centering will be performed."
134   ;; Suggested by earle@mahendo.JPL.NASA.GOV (Greg Earle).
135   ;; Recenter only when requested.  Suggested by popovich@park.cs.columbia.edu.
136   ;; Force redisplay to get properly computed window height.
137   (when gnus-xmas-force-redisplay
138     (sit-for 0))
139   (when gnus-auto-center-summary
140     (let* ((height (if (fboundp 'window-displayed-height)
141                        (window-displayed-height)
142                      (- (window-height) 2)))
143            (top (cond ((< height 4) 0)
144                       ((< height 7) 1)
145                       (t (if (numberp gnus-auto-center-summary)
146                              gnus-auto-center-summary
147                            2))))
148            (bottom (save-excursion (goto-char (point-max))
149                                    (forward-line (- height))
150                                    (point)))
151            (window (get-buffer-window (current-buffer))))
152       (when (get-buffer-window gnus-article-buffer)
153         ;; Only do recentering when the article buffer is displayed,
154         ;; Set the window start to either `bottom', which is the biggest
155         ;; possible valid number, or the second line from the top,
156         ;; whichever is the least.
157         ;; NOFORCE parameter suggested by Daniel Pittman <daniel@danann.net>.
158         (set-window-start
159          window (min bottom (save-excursion (forward-line (- top)) (point)))
160          t))
161       ;; Do horizontal recentering while we're at it.
162       (when (and (get-buffer-window (current-buffer) t)
163                  (not (eq gnus-auto-center-summary 'vertical)))
164         (let ((selected (selected-window)))
165           (select-window (get-buffer-window (current-buffer) t))
166           (gnus-summary-position-point)
167           (gnus-horizontal-recenter)
168           (select-window selected))))))
169
170 (defun gnus-xmas-summary-set-display-table ()
171   ;; Setup the display table -- like `gnus-summary-setup-display-table',
172   ;; but done in an XEmacsish way.
173   (let ((table (make-display-table))
174         (i 32))
175     ;; Nix out all the control chars...
176     (while (>= (setq i (1- i)) 0)
177       (gnus-put-display-table i [??] table))
178     ;; ... but not newline and cr, of course.  (cr is necessary for the
179     ;; selective display).
180     (gnus-put-display-table ?\n nil table)
181     (gnus-put-display-table ?\r nil table)
182     ;; We keep TAB as well.
183     (gnus-put-display-table ?\t nil table)
184     ;; We nix out any glyphs over 126 below ctl-arrow.
185     (let ((i (if (integerp ctl-arrow) ctl-arrow 160)))
186       (while (>= (setq i (1- i)) 127)
187         (unless (gnus-get-display-table i table)
188           (gnus-put-display-table i [??] table))))
189     ;; Can't use `set-specifier' because of a bug in 19.14 and earlier
190     (add-spec-to-specifier current-display-table table (current-buffer) nil)))
191
192 (defun gnus-xmas-add-text-properties (start end props &optional object)
193   (add-text-properties start end props object)
194   (put-text-property start end 'start-closed nil object))
195
196 (defun gnus-xmas-put-text-property (start end prop value &optional object)
197   (put-text-property start end prop value object)
198   (put-text-property start end 'start-closed nil object))
199
200 (defun gnus-xmas-extent-start-open (point)
201   (map-extents (lambda (extent arg)
202                  (set-extent-property extent 'start-open t))
203                nil point (min (1+ (point)) (point-max))))
204
205 (defun gnus-xmas-article-push-button (event)
206   "Check text under the mouse pointer for a callback function.
207 If the text under the mouse pointer has a `gnus-callback' property,
208 call it with the value of the `gnus-data' text property."
209   (interactive "e")
210   (set-buffer (window-buffer (event-window event)))
211   (let* ((pos (event-closest-point event))
212          (data (get-text-property pos 'gnus-data))
213          (fun (get-text-property pos 'gnus-callback)))
214     (goto-char pos)
215     (when fun
216       (funcall fun data))))
217
218 (defun gnus-xmas-move-overlay (extent start end &optional buffer)
219   (set-extent-endpoints extent start end buffer))
220
221 (defun gnus-xmas-kill-all-overlays ()
222   "Delete all extents in the current buffer."
223   (map-extents (lambda (extent ignore)
224                  (delete-extent extent)
225                  nil)))
226
227 (defun gnus-xmas-overlays-in (beg end)
228   "Return a list of the extents that overlap the region BEG ... END."
229   (mapcar-extents #'identity nil nil beg end))
230
231 (defun gnus-xmas-window-top-edge (&optional window)
232   (nth 1 (window-pixel-edges window)))
233
234 (defun gnus-xmas-tree-minimize ()
235   (when (and gnus-tree-minimize-window
236              (not (one-window-p)))
237     (let* ((window-min-height 2)
238            (height (1+ (count-lines (point-min) (point-max))))
239            (min (max (1- window-min-height) height))
240            (tot (if (numberp gnus-tree-minimize-window)
241                     (min gnus-tree-minimize-window min)
242                   min))
243            (win (get-buffer-window (current-buffer)))
244            (wh (and win (1- (window-height win)))))
245       (when (and win
246                  (not (eq tot wh)))
247         (let ((selected (selected-window)))
248           (select-window win)
249           (enlarge-window (- tot wh))
250           (select-window selected))))))
251
252 ;; Select the lowest window on the frame.
253 (defun gnus-xmas-select-lowest-window ()
254   (let* ((lowest-window (selected-window))
255          (bottom-edge (car (cdr (cdr (cdr (window-pixel-edges))))))
256          (last-window (previous-window))
257          (window-search t))
258     (while window-search
259       (let* ((this-window (next-window))
260              (next-bottom-edge (car (cdr (cdr (cdr
261                                                (window-pixel-edges
262                                                 this-window)))))))
263         (when (< bottom-edge next-bottom-edge)
264           (setq bottom-edge next-bottom-edge)
265           (setq lowest-window this-window))
266
267         (select-window this-window)
268         (when (eq last-window this-window)
269           (select-window lowest-window)
270           (setq window-search nil))))))
271
272 (defmacro gnus-xmas-menu-add (type &rest menus)
273   `(gnus-xmas-menu-add-1 ',type ',menus))
274 (put 'gnus-xmas-menu-add 'lisp-indent-function 1)
275
276 (defun gnus-xmas-menu-add-1 (type menus)
277   (when (and menu-bar-mode
278              (gnus-visual-p (intern (format "%s-menu" type)) 'menu))
279     (while menus
280       (easy-menu-add (symbol-value (pop menus))))))
281
282 (defun gnus-xmas-group-menu-add ()
283   (gnus-xmas-menu-add group
284     gnus-group-reading-menu gnus-group-group-menu gnus-group-misc-menu))
285
286 (defun gnus-xmas-summary-menu-add ()
287   (gnus-xmas-menu-add summary
288     gnus-summary-misc-menu gnus-summary-kill-menu
289     gnus-summary-article-menu gnus-summary-thread-menu
290     gnus-summary-post-menu ))
291
292 (defun gnus-xmas-article-menu-add ()
293   (gnus-xmas-menu-add article
294     gnus-article-article-menu gnus-article-treatment-menu
295     gnus-article-post-menu gnus-article-commands-menu))
296
297 (defun gnus-xmas-score-menu-add ()
298   (gnus-xmas-menu-add score
299     gnus-score-menu))
300
301 (defun gnus-xmas-pick-menu-add ()
302   (gnus-xmas-menu-add pick
303     gnus-pick-menu))
304
305 (defun gnus-xmas-topic-menu-add ()
306   (gnus-xmas-menu-add topic
307     gnus-topic-menu))
308
309 (defun gnus-xmas-binary-menu-add ()
310   (gnus-xmas-menu-add binary
311     gnus-binary-menu))
312
313 (defun gnus-xmas-agent-summary-menu-add ()
314   (gnus-xmas-menu-add agent-summary
315     gnus-agent-summary-menu))
316
317 (defun gnus-xmas-agent-group-menu-add ()
318   (gnus-xmas-menu-add agent-group
319     gnus-agent-group-menu))
320
321 (defun gnus-xmas-agent-server-menu-add ()
322   (gnus-xmas-menu-add agent-server
323     gnus-agent-server-menu))
324
325 (defun gnus-xmas-tree-menu-add ()
326   (gnus-xmas-menu-add tree
327     gnus-tree-menu))
328
329 (defun gnus-xmas-draft-menu-add ()
330   (gnus-xmas-menu-add draft
331     gnus-draft-menu))
332
333 (defun gnus-xmas-server-menu-add ()
334   (gnus-xmas-menu-add menu
335     gnus-server-server-menu gnus-server-connections-menu))
336
337 (defun gnus-xmas-browse-menu-add ()
338   (gnus-xmas-menu-add browse
339     gnus-browse-menu))
340
341 (defun gnus-xmas-read-event-char (&optional prompt)
342   "Get the next event."
343   (when prompt
344     (display-message 'no-log (format "%s" prompt)))
345   (let ((event (next-command-event)))
346     (sit-for 0)
347     ;; We junk all non-key events.  Is this naughty?
348     (while (not (or (key-press-event-p event)
349                     (button-press-event-p event)))
350       (dispatch-event event)
351       (setq event (next-command-event)))
352     (cons (and (key-press-event-p event)
353                (event-to-character event))
354           event)))
355
356 (defun gnus-xmas-article-describe-bindings (&optional prefix)
357   "Show a list of all defined keys, and their definitions.
358 The optional argument PREFIX, if non-nil, should be a key sequence;
359 then we display only bindings that start with that prefix."
360   (interactive)
361   (gnus-article-check-buffer)
362   (let ((keymap (copy-keymap gnus-article-mode-map))
363         (map (copy-keymap gnus-article-send-map))
364         (sumkeys (where-is-internal 'gnus-article-read-summary-keys))
365         parent agent draft)
366     (define-key keymap "S" map)
367     (set-keymap-default-binding map nil)
368     (with-current-buffer gnus-article-current-summary
369       (set-keymap-parent
370        keymap
371        (if (setq parent (keymap-parent gnus-article-mode-map))
372            (prog1
373                (setq parent (copy-keymap parent))
374              (set-keymap-parent parent (current-local-map)))
375          (current-local-map)))
376       (let ((def (key-binding "S"))
377             gnus-pick-mode)
378         (set-keymap-parent map (if (symbolp def)
379                                    (symbol-value def)
380                                  def))
381         (dolist (key sumkeys)
382           (when (setq def (key-binding key))
383             (define-key keymap key def))))
384       (when (boundp 'gnus-agent-summary-mode)
385         (setq agent gnus-agent-summary-mode))
386       (when (boundp 'gnus-draft-mode)
387         (setq draft gnus-draft-mode)))
388     (with-temp-buffer
389       (setq major-mode 'gnus-article-mode)
390       (use-local-map keymap)
391       (set (make-local-variable 'gnus-agent-summary-mode) agent)
392       (set (make-local-variable 'gnus-draft-mode) draft)
393       (describe-bindings prefix))))
394
395 (defun gnus-xmas-define ()
396   (setq gnus-mouse-2 [button2])
397   (setq gnus-mouse-3 [button3])
398   (setq gnus-widget-button-keymap widget-button-keymap)
399
400   (unless (memq 'underline (face-list))
401     (and (fboundp 'make-face)
402          (funcall (intern "make-face") 'underline)))
403   ;; Must avoid calling set-face-underline-p directly, because it
404   ;; is a defsubst in emacs19, and will make the .elc files non
405   ;; portable!
406   (unless (face-differs-from-default-p 'underline)
407     (funcall (intern "set-face-underline-p") 'underline t))
408
409   (cond
410    ((fboundp 'char-or-char-int-p)
411     ;; Handle both types of marks for XEmacs-20.x.
412     (defalias 'gnus-characterp 'char-or-char-int-p))
413    ;; V19 of XEmacs, probably.
414    (t
415     (defalias 'gnus-characterp 'characterp)))
416
417   (defalias 'gnus-make-overlay
418     (lambda (beg end &optional buffer front-advance rear-advance)
419       "Create a new overlay with range BEG to END in BUFFER.
420 FRONT-ADVANCE and REAR-ADVANCE are ignored."
421       (make-extent beg end buffer)))
422
423   (defalias 'gnus-delete-overlay 'delete-extent)
424   (defalias 'gnus-overlay-get 'extent-property)
425   (defalias 'gnus-overlay-put 'set-extent-property)
426   (defalias 'gnus-move-overlay 'gnus-xmas-move-overlay)
427   (defalias 'gnus-overlay-buffer 'extent-object)
428   (defalias 'gnus-overlay-start 'extent-start-position)
429   (defalias 'gnus-overlay-end 'extent-end-position)
430   (defalias 'gnus-overlays-in 'gnus-xmas-overlays-in)
431   (defalias 'gnus-kill-all-overlays 'gnus-xmas-kill-all-overlays)
432   (defalias 'gnus-extent-detached-p 'extent-detached-p)
433   (defalias 'gnus-add-text-properties 'gnus-xmas-add-text-properties)
434   (defalias 'gnus-put-text-property 'gnus-xmas-put-text-property)
435   (defalias 'gnus-deactivate-mark 'ignore)
436   (defalias 'gnus-window-edges 'window-pixel-edges)
437   (defalias 'gnus-assq-delete-all 'gnus-xmas-assq-delete-all)
438
439   (unless (boundp 'standard-display-table)
440     (setq standard-display-table nil))
441
442   (defvar gnus-mouse-face-prop 'highlight)
443
444   (defun gnus-byte-code (func)
445     "Return a form that can be `eval'ed based on FUNC."
446     (let ((fval (indirect-function func)))
447       (if (compiled-function-p fval)
448           (list 'funcall fval)
449         (cons 'progn (cdr (cdr fval))))))
450
451   (unless (fboundp 'match-string-no-properties)
452     (defalias 'match-string-no-properties 'match-string))
453
454   (defalias 'gnus-x-color-values
455         (if (fboundp 'x-color-values)
456             'x-color-values
457           (lambda (color)
458             (color-instance-rgb-components
459              (make-color-instance color)))))
460
461   (unless (fboundp 'char-width)
462     (defalias 'char-width (lambda (ch) 1))))
463
464 (defun gnus-xmas-redefine ()
465   "Redefine lots of Gnus functions for XEmacs."
466   (defalias 'gnus-summary-set-display-table 'gnus-xmas-summary-set-display-table)
467   (defalias 'gnus-visual-turn-off-edit-menu 'identity)
468   (defalias 'gnus-summary-recenter 'gnus-xmas-summary-recenter)
469   (defalias 'gnus-extent-start-open 'gnus-xmas-extent-start-open)
470   (defalias 'gnus-article-push-button 'gnus-xmas-article-push-button)
471   (defalias 'gnus-window-top-edge 'gnus-xmas-window-top-edge)
472   (defalias 'gnus-read-event-char 'gnus-xmas-read-event-char)
473   (defalias 'gnus-group-startup-message 'gnus-xmas-group-startup-message)
474   (defalias 'gnus-tree-minimize 'gnus-xmas-tree-minimize)
475   (defalias 'gnus-select-lowest-window
476     'gnus-xmas-select-lowest-window)
477   (defalias 'gnus-mail-strip-quoted-names 'gnus-xmas-mail-strip-quoted-names)
478   (defalias 'gnus-character-to-event 'character-to-event)
479   (defalias 'gnus-mode-line-buffer-identification
480     'gnus-xmas-mode-line-buffer-identification)
481   (defalias 'gnus-key-press-event-p 'key-press-event-p)
482   (defalias 'gnus-region-active-p 'region-active-p)
483   (defalias 'gnus-mark-active-p 'region-exists-p)
484   (defalias 'gnus-annotation-in-region-p 'gnus-xmas-annotation-in-region-p)
485   (defalias 'gnus-mime-button-menu 'gnus-xmas-mime-button-menu)
486   (defalias 'gnus-mime-security-button-menu
487     'gnus-xmas-mime-security-button-menu)
488   (defalias 'gnus-image-type-available-p 'gnus-xmas-image-type-available-p)
489   (defalias 'gnus-put-image 'gnus-xmas-put-image)
490   (defalias 'gnus-create-image 'gnus-xmas-create-image)
491   (defalias 'gnus-remove-image 'gnus-xmas-remove-image)
492   (defalias 'gnus-article-describe-bindings
493     'gnus-xmas-article-describe-bindings)
494
495   ;; These ones are not defcutom'ed, sometimes not even defvar'ed. They
496   ;; probably should. If that is done, the code below should then be moved
497   ;; where each variable is defined, in order not to mess with user settings.
498   ;; -- didier
499   (add-hook 'gnus-score-mode-hook 'gnus-xmas-score-menu-add)
500   (add-hook 'gnus-binary-mode-hook 'gnus-xmas-binary-menu-add)
501   (add-hook 'gnus-server-mode-hook 'gnus-xmas-server-menu-add)
502   (add-hook 'gnus-browse-mode-hook 'gnus-xmas-browse-menu-add)
503   (add-hook 'gnus-draft-mode-hook 'gnus-xmas-draft-menu-add)
504   (add-hook 'gnus-mailing-list-mode-hook 'gnus-xmas-mailing-list-menu-add))
505
506
507 ;;; XEmacs logo and toolbar.
508
509 (defun gnus-xmas-group-startup-message (&optional x y)
510   "Insert startup message in current buffer."
511   ;; Insert the message.
512   (erase-buffer)
513   (cond
514    ((and (console-on-window-system-p)
515          (or (featurep 'xpm)
516              (featurep 'xbm)))
517     (let* ((logo-xpm (expand-file-name "gnus.xpm" gnus-xmas-glyph-directory))
518            (logo-xbm (expand-file-name "gnus.xbm" gnus-xmas-glyph-directory))
519            (glyph (make-glyph
520                    (cond ((featurep 'xpm)
521                           `[xpm
522                             :file ,logo-xpm
523                             :color-symbols
524                             (("thing" . ,(car gnus-logo-colors))
525                              ("shadow" . ,(cadr gnus-logo-colors))
526                              ("oort" . "#eeeeee")
527                              ("background" . ,(face-background 'default)))])
528                          ((featurep 'xbm)
529                           `[xbm :file ,logo-xbm])
530                          (t [nothing])))))
531       (insert " ")
532       (set-extent-begin-glyph (make-extent (point) (point)) glyph)
533       (goto-char (point-min))
534       (while (not (eobp))
535         (insert (make-string (/ (max (- (window-width) (or x 35)) 0) 2)
536                              ?\ ))
537         (forward-line 1))
538       (setq gnus-simple-splash nil))
539     (goto-char (point-min))
540     (let* ((pheight (+ 20 (count-lines (point-min) (point-max))))
541            (wheight (window-height))
542            (rest (- wheight pheight)))
543       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n))))
544    (t
545     (insert
546      (format "              %s
547           _    ___ _             _
548           _ ___ __ ___  __    _ ___
549           __   _     ___    __  ___
550               _           ___     _
551              _  _ __             _
552              ___   __            _
553                    __           _
554                     _      _   _
555                    _      _    _
556                       _  _    _
557                   __  ___
558                  _   _ _     _
559                 _   _
560               _    _
561              _    _
562             _
563           __
564
565 "
566              ""))
567     ;; And then hack it.
568     (gnus-indent-rigidly (point-min) (point-max)
569                          (/ (max (- (window-width) (or x 46)) 0) 2))
570     (goto-char (point-min))
571     (forward-line 1)
572     (let* ((pheight (count-lines (point-min) (point-max)))
573            (wheight (window-height))
574            (rest (- wheight pheight)))
575       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
576     ;; Paint it.
577     (put-text-property (point-min) (point-max) 'face 'gnus-splash)))
578   (setq modeline-buffer-identification
579         (list (concat gnus-version ": *Group*")))
580   (set-buffer-modified-p t))
581
582
583 ;;; The toolbar.
584
585 (defun gnus-xmas-update-toolbars ()
586   "Update the toolbars' appearance."
587   (when (and (not noninteractive)
588              (featurep 'gnus-xmas))
589     (save-excursion
590       (dolist (buffer (buffer-list))
591         (set-buffer buffer)
592         (cond ((eq major-mode 'gnus-group-mode)
593                (gnus-xmas-setup-group-toolbar))
594               ((eq major-mode 'gnus-summary-mode)
595                (gnus-xmas-setup-summary-toolbar)))))))
596
597 (defcustom gnus-use-toolbar (if (featurep 'toolbar) 'default)
598   "*Position to display the toolbar.  Nil means do not use a toolbar.
599 If it is non-nil, it should be one of the symbols `default', `top',
600 `bottom', `right', and `left'.  `default' means to use the default
601 toolbar, the rest mean to display the toolbar on the place which those
602 names show."
603   :type '(choice (const default)
604                  (const top) (const bottom) (const left) (const right)
605                  (const :tag "no toolbar" nil))
606   :set (lambda (symbol value)
607          (set-default
608           symbol
609           (if (or (not value)
610                   (memq value (list 'default 'top 'bottom 'right 'left)))
611               value
612             'default))
613          (gnus-xmas-update-toolbars))
614   :group 'gnus-xmas)
615
616 (defcustom gnus-toolbar-thickness
617   (if (featurep 'toolbar)
618       (cons (specifier-instance default-toolbar-height)
619             (specifier-instance default-toolbar-width)))
620   "*Cons of the height and the width specifying the thickness of a toolbar.
621 The height is used for the toolbar displayed on the top or the bottom,
622 the width is used for the toolbar displayed on the right or the left."
623   :type '(cons :tag "height & width"
624                (integer :tag "height") (integer :tag "width"))
625   :set (lambda (symbol value)
626          (set-default
627           symbol
628           (if (and (consp value) (natnump (car value)) (natnump (cdr value)))
629               value
630             '(37 . 40)))
631          (gnus-xmas-update-toolbars))
632   :group 'gnus-xmas)
633
634 (defvar gnus-group-toolbar
635   '([gnus-group-get-new-news gnus-group-get-new-news t "Get new news"]
636     [gnus-group-get-new-news-this-group
637      gnus-group-get-new-news-this-group t "Get new news in this group"]
638     [gnus-group-catchup-current
639      gnus-group-catchup-current t "Catchup group"]
640     [gnus-group-describe-group
641      gnus-group-describe-group t "Describe group"]
642     [gnus-group-unsubscribe gnus-group-unsubscribe t "Unsubscribe group"]
643     [gnus-group-subscribe gnus-group-subscribe t "Subscribe group"]
644     [gnus-group-kill-group gnus-group-kill-group t "Kill group"]
645     [gnus-summary-mail-save
646      gnus-group-save-newsrc t "Save .newsrc files"] ; borrowed icon.
647     [gnus-group-exit gnus-group-exit t "Exit Gnus"])
648   "The group buffer toolbar.")
649
650 (defvar gnus-summary-toolbar
651   '([gnus-summary-prev-unread
652      gnus-summary-prev-page-or-article t "Page up"]
653     [gnus-summary-next-unread
654      gnus-summary-next-page t "Page down"]
655     [gnus-summary-post-news
656      gnus-summary-post-news t "Post an article"]
657     [gnus-summary-followup-with-original
658      gnus-summary-followup-with-original t
659      "Post a followup and yank the original"]
660     [gnus-summary-followup
661      gnus-summary-followup t "Post a followup"]
662     [gnus-summary-reply-with-original
663      gnus-summary-reply-with-original t "Mail a reply and yank the original"]
664     [gnus-summary-reply
665      gnus-summary-reply t "Mail a reply"]
666     [gnus-summary-caesar-message
667      gnus-summary-caesar-message t "Rot 13"]
668     [gnus-uu-decode-uu
669      gnus-uu-decode-uu t "Decode uuencoded articles"]
670     [gnus-summary-save-article-file
671      gnus-summary-save-article-file t "Save article in file"]
672     [gnus-summary-save-article
673      gnus-summary-save-article t "Save article"]
674     [gnus-uu-post-news
675      gnus-uu-post-news t "Post a uuencoded article"]
676     [gnus-summary-cancel-article
677      gnus-summary-cancel-article t "Cancel article"]
678     [gnus-summary-catchup
679      gnus-summary-catchup t "Catchup"]
680     [gnus-summary-catchup-and-exit
681      gnus-summary-catchup-and-exit t "Catchup and exit"]
682     [gnus-summary-exit gnus-summary-exit t "Exit this summary"])
683   "The summary buffer toolbar.")
684
685 (defvar gnus-summary-mail-toolbar
686   '(
687     [gnus-summary-prev-unread
688      gnus-summary-prev-unread-article t "Prev unread article"]
689     [gnus-summary-next-unread
690      gnus-summary-next-unread-article t "Next unread article"]
691     [gnus-summary-mail-reply gnus-summary-reply t "Reply"]
692     [gnus-summary-mail-originate gnus-summary-post-news t "Originate"]
693     [gnus-summary-mail-save gnus-summary-save-article t "Save"]
694     [gnus-summary-mail-copy gnus-summary-copy-article t "Copy message"]
695     [gnus-summary-mail-forward gnus-summary-mail-forward t "Forward message"]
696     [gnus-summary-caesar-message
697      gnus-summary-caesar-message t "Rot 13"]
698     [gnus-uu-decode-uu
699      gnus-uu-decode-uu t "Decode uuencoded articles"]
700     [gnus-summary-save-article-file
701      gnus-summary-save-article-file t "Save article in file"]
702     [gnus-summary-save-article
703      gnus-summary-save-article t "Save article"]
704     [gnus-summary-cancel-article ; usenet : cancellation :: mail : deletion.
705      gnus-summary-delete-article t "Delete message"]
706     [gnus-summary-catchup
707      gnus-summary-catchup t "Catchup"]
708     [gnus-summary-catchup-and-exit
709      gnus-summary-catchup-and-exit t "Catchup and exit"]
710     [gnus-summary-exit gnus-summary-exit t "Exit this summary"])
711   "The summary buffer mail toolbar.")
712
713 (defun gnus-xmas-setup-toolbar (toolbar)
714   (when (featurep 'toolbar)
715     (if (and gnus-use-toolbar
716              (message-xmas-setup-toolbar toolbar nil "gnus"))
717         (let ((bar (or (intern-soft (format "%s-toolbar" gnus-use-toolbar))
718                        'default-toolbar))
719               (height (car gnus-toolbar-thickness))
720               (width (cdr gnus-toolbar-thickness))
721               (cur (current-buffer))
722               bars)
723           (set-specifier (symbol-value bar) toolbar cur)
724           (set-specifier default-toolbar-height height cur)
725           (set-specifier default-toolbar-width width cur)
726           (set-specifier top-toolbar-height height cur)
727           (set-specifier bottom-toolbar-height height cur)
728           (set-specifier right-toolbar-width width cur)
729           (set-specifier left-toolbar-width width cur)
730           (if (eq bar 'default-toolbar)
731               (progn
732                 (remove-specifier default-toolbar-visible-p cur)
733                 (remove-specifier top-toolbar cur)
734                 (remove-specifier top-toolbar-visible-p cur)
735                 (remove-specifier bottom-toolbar cur)
736                 (remove-specifier bottom-toolbar-visible-p cur)
737                 (remove-specifier right-toolbar cur)
738                 (remove-specifier right-toolbar-visible-p cur)
739                 (remove-specifier left-toolbar cur)
740                 (remove-specifier left-toolbar-visible-p cur))
741             (set-specifier (symbol-value (intern (format "%s-visible-p" bar)))
742                            t cur)
743             (setq bars (delq bar (list 'default-toolbar
744                                        'bottom-toolbar 'top-toolbar
745                                        'right-toolbar 'left-toolbar)))
746             (while bars
747               (set-specifier (symbol-value (intern (format "%s-visible-p"
748                                                            (pop bars))))
749                              nil cur))))
750       (let ((cur (current-buffer)))
751         (set-specifier default-toolbar-visible-p nil cur)
752         (set-specifier top-toolbar-visible-p nil cur)
753         (set-specifier bottom-toolbar-visible-p nil cur)
754         (set-specifier right-toolbar-visible-p nil cur)
755         (set-specifier left-toolbar-visible-p nil cur)))))
756
757 (defun gnus-xmas-setup-group-toolbar ()
758   (gnus-xmas-setup-toolbar gnus-group-toolbar))
759
760 (defun gnus-xmas-setup-summary-toolbar ()
761   (gnus-xmas-setup-toolbar (if (gnus-news-group-p gnus-newsgroup-name)
762                                gnus-summary-toolbar
763                              gnus-summary-mail-toolbar)))
764
765 (defun gnus-xmas-mail-strip-quoted-names (address)
766   "Protect mail-strip-quoted-names from nil input.
767 XEmacs compatibility workaround."
768   (if (null address)
769       nil
770     (mail-strip-quoted-names address)))
771
772 (defun gnus-xmas-call-region (command &rest args)
773   (apply
774    'call-process-region (point-min) (point-max) command t '(t nil) nil
775    args))
776
777 (defvar gnus-xmas-modeline-left-extent
778   (let ((ext (copy-extent modeline-buffer-id-left-extent)))
779     ext))
780
781 (defvar gnus-xmas-modeline-right-extent
782   (let ((ext (copy-extent modeline-buffer-id-right-extent)))
783     ext))
784
785 (defvar gnus-xmas-modeline-glyph
786   (progn
787     (let* ((file-xpm (expand-file-name "gnus-pointer.xpm"
788                                        gnus-xmas-glyph-directory))
789            (file-xbm (expand-file-name "gnus-pointer.xbm"
790                                        gnus-xmas-glyph-directory))
791            (glyph (make-glyph
792                    ;; Gag gag gag.
793                    (cond ((featurep 'xpm)
794                           ;; Let's try a nifty XPM
795                           `[xpm :file ,file-xpm])
796                          ((featurep 'xbm)
797                           ;; Then a not-so-nifty XBM
798                           `[xbm :file ,file-xbm])
799                          ;; Then the simple string
800                          (t [string :data "Gnus:"])))))
801       (set-glyph-face glyph 'modeline-buffer-id)
802       glyph)))
803
804 (defun gnus-xmas-mode-line-buffer-identification (line)
805   (let ((line (car line))
806         chop)
807     (cond
808      ;; This is some weird type of id.
809      ((not (stringp line))
810       (list line))
811      ;; This is non-standard, so we just pass it through.
812      ((not (string-match "^Gnus:" line))
813       (list line))
814      ;; We have a standard line, so we colorize and glyphize it a bit.
815      (t
816       (setq chop (match-end 0))
817       (list
818        (if gnus-xmas-modeline-glyph
819            (cons gnus-xmas-modeline-left-extent gnus-xmas-modeline-glyph)
820          (cons gnus-xmas-modeline-left-extent (substring line 0 chop)))
821        (cons gnus-xmas-modeline-right-extent (substring line chop)))))))
822
823 (defun gnus-xmas-splash ()
824   (when (eq (device-type) 'x)
825     (gnus-splash)))
826
827 (defun gnus-xmas-annotation-in-region-p (b e)
828   (or (map-extents (lambda (e u) t) nil b e nil nil 'mm t)
829       (if (= b e)
830           (eq (cadr (memq 'gnus-undeletable (text-properties-at b))) t)
831         (text-property-any b e 'gnus-undeletable t))))
832
833 (defun gnus-xmas-mime-button-menu (event prefix)
834   "Construct a context-sensitive menu of MIME commands."
835   (interactive "e\nP")
836   (let ((response (get-popup-menu-response
837                    `("MIME Part"
838                      ,@(mapcar (lambda (c) `[,(caddr c) ,(car c) t])
839                                gnus-mime-button-commands)))))
840     (set-buffer (event-buffer event))
841     (goto-char (event-point event))
842     (funcall (event-function response) (event-object response))))
843
844 (defun gnus-xmas-mime-security-button-menu (event prefix)
845   "Construct a context-sensitive menu of security commands."
846   (interactive "e\nP")
847   (let ((response
848          (get-popup-menu-response
849           `("Security Part"
850             ,@(delq nil
851                     (mapcar (lambda (c)
852                               (unless (eq (car c) 'undefined)
853                                 `[,(caddr c) ,(car c) t]))
854                             gnus-mime-security-button-commands))))))
855     (set-buffer (event-buffer event))
856     (goto-char (event-point event))
857     (funcall (event-function response) (event-object response))))
858
859 (defun gnus-xmas-mailing-list-menu-add ()
860   (gnus-xmas-menu-add mailing-list
861                       gnus-mailing-list-menu))
862
863 (defun gnus-xmas-image-type-available-p (type)
864   (and (if (fboundp 'display-images-p)
865            (display-images-p)
866          window-system)
867        (featurep (if (eq type 'pbm) 'xbm type))))
868
869 (defun gnus-xmas-create-image (file &optional type data-p &rest props)
870   (let ((type (cond
871                (type
872                 (symbol-name type))
873                ((and (not data-p)
874                      (string-match "[.]" file))
875                 (car (last (split-string file "[.]"))))))
876         (face (plist-get props :face))
877         glyph)
878     (when (equal type "pbm")
879       (with-temp-buffer
880         (if data-p
881             (insert file)
882           (insert-file-contents-literally file))
883         (shell-command-on-region (point-min) (point-max)
884                                  "ppmtoxpm 2>/dev/null" t)
885         (setq file (buffer-string)
886               type "xpm"
887               data-p t)))
888     (setq glyph
889           (if (equal type "xbm")
890               (make-glyph (list (cons 'x file)))
891             (with-temp-buffer
892               (if data-p
893                   (insert file)
894                 (insert-file-contents-literally file))
895               (make-glyph
896                (vector
897                 (if type
898                     (intern type)
899                   (mm-image-type-from-buffer))
900                 :data (buffer-string))))))
901     (when face
902       (set-glyph-face glyph face))
903     glyph))
904
905 (defun gnus-xmas-put-image (glyph &optional string category)
906   "Insert STRING, but display GLYPH.
907 Warning: Don't insert text immediately after the image."
908   (let ((begin (point))
909         extent)
910     (if (and (bobp) (not string))
911         (setq string " "))
912     (if string
913         (insert string)
914       (setq begin (1- begin)))
915     (setq extent (make-extent begin (point)))
916     (set-extent-property extent 'gnus-image category)
917     (set-extent-property extent 'duplicable t)
918     (if string
919         (set-extent-property extent 'invisible t))
920     (set-extent-property extent 'end-glyph glyph))
921   glyph)
922
923 (defun gnus-xmas-remove-image (image &optional category)
924   "Remove the image matching IMAGE and CATEGORY found first."
925   (map-extents
926    (lambda (ext unused)
927      (when (equal (extent-end-glyph ext) image)
928        (set-extent-property ext 'invisible nil)
929        (set-extent-property ext 'end-glyph nil)
930        t))
931    nil nil nil nil nil 'gnus-image category))
932
933 (defun gnus-xmas-assq-delete-all (key alist)
934   (let ((elem nil))
935     (while (setq elem (assq key alist))
936       (setq alist (delq elem alist)))
937     alist))
938
939 (provide 'gnus-xmas)
940
941 ;;; gnus-xmas.el ends here