git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-xmas.el

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