cgit.sxemacs.org Git - gnus/blob - lisp/gnus-xmas.el

   1 ;;; gnus-xmas.el --- Gnus functions for XEmacs
   2 ;; Copyright (C) 1995 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
   5 ;; Keywords: news
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 (require 'text-props)
  28 (defvar menu-bar-mode t)
  29
  30 (defvar gnus-xmas-glyph-directory nil
  31   "*Directory where Gnus logos and icons are located.
  32 If this variable is nil, Gnus will try to locate the directory
  33 automatically.")
  34
  35 ;;; Internal variables.
  36
  37 (defvar gnus-xmas-logo (make-glyph (make-specifier 'image)))
  38
  39 ;; Don't warn about these undefined variables.
  40
  41 (defvar gnus-group-mode-hook)
  42 (defvar gnus-summary-mode-hook)
  43 (defvar gnus-article-mode-hook)
  44
  45 ;;defined in gnus.el
  46 (defvar gnus-active-hashtb)
  47 (defvar gnus-article-buffer)
  48 (defvar gnus-auto-center-summary)
  49 (defvar gnus-buffer-list)
  50 (defvar gnus-current-headers)
  51 (defvar gnus-level-killed)
  52 (defvar gnus-level-zombie)
  53 (defvar gnus-newsgroup-bookmarks)
  54 (defvar gnus-newsgroup-dependencies)
  55 (defvar gnus-newsgroup-selected-overlay)
  56 (defvar gnus-newsrc-hashtb)
  57 (defvar gnus-read-mark)
  58 (defvar gnus-refer-article-method)
  59 (defvar gnus-reffed-article-number)
  60 (defvar gnus-unread-mark)
  61 (defvar gnus-version)
  62 (defvar gnus-view-pseudos)
  63 (defvar gnus-view-pseudos-separately)
  64 (defvar gnus-visual)
  65 (defvar gnus-zombie-list)
  66 ;;defined in gnus-msg.el
  67 (defvar gnus-article-copy)
  68 (defvar gnus-check-before-posting)
  69 ;;defined in gnus-vis.el
  70 (defvar gnus-article-button-face)
  71 (defvar gnus-article-mouse-face)
  72 (defvar gnus-summary-selected-face)
  73 (defvar gnus-group-reading-menu)
  74 (defvar gnus-group-group-menu)
  75 (defvar gnus-group-misc-menu)
  76 (defvar gnus-summary-article-menu)
  77 (defvar gnus-summary-thread-menu)
  78 (defvar gnus-summary-misc-menu)
  79 (defvar gnus-summary-post-menu)
  80 (defvar gnus-summary-kill-menu)
  81 (defvar gnus-article-article-menu)
  82 (defvar gnus-article-treatment-menu)
  83 (defvar gnus-mouse-2)
  84 (defvar standard-display-table)
  85
  86 (defun gnus-xmas-set-text-properties (start end props &optional buffer)
  87   "You should NEVER use this function.  It is ideologically blasphemous.
  88 It is provided only to ease porting of broken FSF Emacs programs."
  89   (if (and (stringp buffer) (not (setq buffer (get-buffer buffer))))
  90       nil
  91     (map-extents (lambda (extent ignored)
  92                    (remove-text-properties
  93                     start end
  94                     (list (extent-property extent 'text-prop) nil)
  95                     buffer))
  96                  buffer start end nil nil 'text-prop)
  97     (add-text-properties start end props buffer)))
  98
  99 (defun gnus-xmas-highlight-selected-summary ()
 100   ;; Highlight selected article in summary buffer
 101   (if gnus-summary-selected-face
 102       (progn
 103         (if gnus-newsgroup-selected-overlay
 104             (delete-extent gnus-newsgroup-selected-overlay))
 105         (setq gnus-newsgroup-selected-overlay
 106               (make-extent (gnus-point-at-bol) (gnus-point-at-eol)))
 107         (set-extent-face gnus-newsgroup-selected-overlay
 108                          gnus-summary-selected-face))))
 109
 110 (defun gnus-xmas-summary-recenter ()
 111   (let* ((top (cond ((< (window-height) 4) 0)
 112                     ((< (window-height) 7) 1)
 113                     (t 2)))
 114          (height (- (window-height) 2))
 115          (bottom (save-excursion (goto-char (point-max))
 116                                  (forward-line (- height))
 117                                  (point)))
 118          (window (get-buffer-window (current-buffer))))
 119     (and
 120      ;; The user has to want it,
 121      gnus-auto-center-summary
 122      ;; the article buffer must be displayed,
 123      (get-buffer-window gnus-article-buffer)
 124      ;; Set the window start to either `bottom', which is the biggest
 125      ;; possible valid number, or the second line from the top,
 126      ;; whichever is the least.
 127      (set-window-start
 128       window (min bottom (save-excursion
 129                            (forward-line (- top)) (point)))))))
 130
 131 (defun gnus-xmas-group-remove-excess-properties ()
 132   (let ((end (point))
 133         (beg (progn (forward-line -1) (point))))
 134     (remove-text-properties (1+ beg) end '(gnus-group nil))
 135     (remove-text-properties
 136      beg end
 137      '(gnus-topic nil gnus-topic-level nil gnus-topic-visible nil))
 138     (goto-char end)))
 139
 140 (defun gnus-xmas-copy-article-buffer (&optional article-buffer)
 141   (setq gnus-article-copy (get-buffer-create " *gnus article copy*"))
 142   (buffer-disable-undo gnus-article-copy)
 143   (or (memq gnus-article-copy gnus-buffer-list)
 144       (setq gnus-buffer-list (cons gnus-article-copy gnus-buffer-list)))
 145   (let ((article-buffer (or article-buffer gnus-article-buffer))
 146         buf)
 147     (if (and (get-buffer article-buffer)
 148              (buffer-name (get-buffer article-buffer)))
 149         (save-excursion
 150           (set-buffer article-buffer)
 151           (widen)
 152           (setq buf (buffer-substring (point-min) (point-max)))
 153           (set-buffer gnus-article-copy)
 154           (erase-buffer)
 155           (insert (format "%s" buf))))))
 156
 157 (defun gnus-xmas-article-push-button (event)
 158   "Check text under the mouse pointer for a callback function.
 159 If the text under the mouse pointer has a `gnus-callback' property,
 160 call it with the value of the `gnus-data' text property."
 161   (interactive "e")
 162   (set-buffer (window-buffer (event-window event)))
 163   (let* ((pos (event-closest-point event))
 164          (data (get-text-property pos 'gnus-data))
 165          (fun (get-text-property pos 'gnus-callback)))
 166     (if fun (funcall fun data))))
 167
 168 (defun gnus-xmas-move-overlay (extent start end &optional buffer)
 169   (set-extent-endpoints extent start end))
 170
 171 ;; Fixed by Christopher Davis <ckd@loiosh.kei.com>.
 172 (defun gnus-xmas-article-add-button (from to fun &optional data)
 173   "Create a button between FROM and TO with callback FUN and data DATA."
 174   (and gnus-article-button-face
 175        (gnus-overlay-put (gnus-make-overlay from to)
 176                          'face gnus-article-button-face))
 177   (add-text-properties
 178    from to
 179    (nconc
 180     (and gnus-article-mouse-face
 181          (list 'mouse-face gnus-article-mouse-face))
 182     (list 'gnus-callback fun)
 183     (and data (list 'gnus-data data))
 184     (list 'highlight t))))
 185
 186 (defun gnus-xmas-window-top-edge (&optional window)
 187   (nth 1 (window-pixel-edges window)))
 188
 189 ;; Select the lowest window on the frame.
 190 (defun gnus-xmas-appt-select-lowest-window ()
 191   (let* ((lowest-window (selected-window))
 192          (bottom-edge (car (cdr (cdr (cdr (window-pixel-edges))))))
 193          (last-window (previous-window))
 194          (window-search t))
 195     (while window-search
 196       (let* ((this-window (next-window))
 197              (next-bottom-edge (car (cdr (cdr (cdr
 198                                                (window-pixel-edges
 199                                                 this-window)))))))
 200         (if (< bottom-edge next-bottom-edge)
 201             (progn
 202               (setq bottom-edge next-bottom-edge)
 203               (setq lowest-window this-window)))
 204
 205         (select-window this-window)
 206         (if (eq last-window this-window)
 207             (progn
 208               (select-window lowest-window)
 209               (setq window-search nil)))))))
 210
 211 (defun gnus-xmas-group-menu-add ()
 212   (easy-menu-add gnus-group-reading-menu)
 213   (easy-menu-add gnus-group-group-menu)
 214   (easy-menu-add gnus-group-misc-menu))
 215
 216 (defun gnus-xmas-summary-menu-add ()
 217   (easy-menu-add gnus-summary-article-menu)
 218   (easy-menu-add gnus-summary-thread-menu)
 219   (easy-menu-add gnus-summary-misc-menu)
 220   (easy-menu-add gnus-summary-post-menu)
 221   (easy-menu-add gnus-summary-kill-menu))
 222
 223 (defun gnus-xmas-article-menu-add ()
 224   (easy-menu-add gnus-article-article-menu)
 225   (easy-menu-add gnus-article-treatment-menu))
 226
 227
 228 (defun gnus-xmas-define ()
 229   (setq gnus-mouse-2 [button2])
 230
 231   (or (memq 'underline (list-faces))
 232       (and (fboundp 'make-face)
 233            (funcall (intern "make-face") 'underline)))
 234   ;; Must avoid calling set-face-underline-p directly, because it
 235   ;; is a defsubst in emacs19, and will make the .elc files non
 236   ;; portable!
 237   (or (face-differs-from-default-p 'underline)
 238       (funcall (intern "set-face-underline-p") 'underline t))
 239
 240   (fset 'gnus-make-overlay 'make-extent)
 241   (fset 'gnus-overlay-put 'set-extent-property)
 242   (fset 'gnus-move-overlay 'gnus-xmas-move-overlay)
 243
 244   (fset 'set-text-properties 'gnus-xmas-set-text-properties)
 245
 246   (or (boundp 'standard-display-table) (setq standard-display-table nil))
 247   (or (boundp 'read-event) (fset 'read-event 'next-command-event))
 248
 249   (defvar gnus-mouse-face-prop 'highlight)
 250
 251   (defun gnus-byte-code (func)
 252     "Return a form that can be `eval'ed based on FUNC."
 253     (let ((fval (symbol-function func)))
 254       (if (byte-code-function-p fval)
 255           (list 'funcall fval)
 256         (cons 'progn (cdr (cdr fval))))))
 257
 258   ;; Fix by "jeff (j.d.) sparkes" <jsparkes@bnr.ca>.
 259   (defvar gnus-display-type (device-class)
 260     "A symbol indicating the display Emacs is running under.
 261 The symbol should be one of `color', `grayscale' or `mono'. If Emacs
 262 guesses this display attribute wrongly, either set this variable in
 263 your `~/.emacs' or set the resource `Emacs.displayType' in your
 264 `~/.Xdefaults'. See also `gnus-background-mode'.
 265
 266 This is a meta-variable that will affect what default values other
 267 variables get.  You would normally not change this variable, but
 268 pounce directly on the real variables themselves.")
 269
 270
 271   (or (fboundp 'x-color-values)
 272       (fset 'x-color-values
 273             (lambda (color)
 274               (color-instance-rgb-components
 275                (make-color-instance color)))))
 276
 277   (defvar gnus-background-mode
 278     (let ((bg-resource
 279            (condition-case ()
 280                (x-get-resource ".backgroundMode" "BackgroundMode" 'string)
 281              (error nil)))
 282           (params (frame-parameters)))
 283       (cond (bg-resource (intern (downcase bg-resource)))
 284             ((and (assq 'background-color params)
 285                   (< (apply '+ (x-color-values
 286                                 (cdr (assq 'background-color params))))
 287                      (/ (apply '+ (x-color-values "white")) 3)))
 288              'dark)
 289             (t 'light)))
 290     "A symbol indicating the Emacs background brightness.
 291 The symbol should be one of `light' or `dark'.
 292 If Emacs guesses this frame attribute wrongly, either set this variable in
 293 your `~/.emacs' or set the resource `Emacs.backgroundMode' in your
 294 `~/.Xdefaults'.
 295 See also `gnus-display-type'.
 296
 297 This is a meta-variable that will affect what default values other
 298 variables get.  You would normally not change this variable, but
 299 pounce directly on the real variables themselves.")
 300   )
 301
 302
 303
 304 (defun gnus-xmas-redefine ()
 305
 306
 307   (fset 'gnus-summary-make-display-table (lambda () nil))
 308   (fset 'gnus-visual-turn-off-edit-menu 'identity)
 309   (fset 'gnus-highlight-selected-summary
 310         'gnus-xmas-highlight-selected-summary)
 311   (fset 'gnus-summary-recenter 'gnus-xmas-summary-recenter)
 312   (fset 'gnus-group-remove-excess-properties
 313         'gnus-xmas-group-remove-excess-properties)
 314   (fset 'gnus-copy-article-buffer 'gnus-xmas-copy-article-buffer)
 315   (fset 'gnus-article-push-button 'gnus-xmas-article-push-button)
 316   (fset 'gnus-article-add-button 'gnus-xmas-article-add-button)
 317   (fset 'gnus-window-top-edge 'gnus-xmas-window-top-edge)
 318   (fset 'set-text-properties 'gnus-xmas-set-text-properties)
 319
 320   (or (fboundp 'appt-select-lowest-window)
 321       (fset 'appt-select-lowest-window
 322             'gnus-xmas-appt-select-lowest-window))
 323
 324   (add-hook 'gnus-group-mode-hook 'gnus-xmas-group-menu-add)
 325   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-summary-menu-add)
 326   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add)
 327
 328   (add-hook 'gnus-group-mode-hook 'gnus-xmas-setup-group-toolbar)
 329   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-setup-summary-toolbar))
 330
 331
 332 ;;; XEmacs logo and toolbar.
 333
 334 (defun gnus-xmas-find-glyph-directory ()
 335   (or gnus-xmas-glyph-directory ; We have a dir already...
 336       (let ((path load-path)
 337             dir)
 338         ;; We try to find the dir by looking at the load path,
 339         ;; stripping away the last component and adding "etc/".
 340         (while path
 341           (setq dir (concat
 342                      (file-name-directory (directory-file-name (car path)))
 343                      "etc/"))
 344           (if (and (file-exists-p dir)
 345                    (file-directory-p dir)
 346                    (file-exists-p (concat dir "gnus-group-exit-icon-up.xpm")))
 347               (setq gnus-xmas-glyph-directory dir
 348                     path nil)
 349             (setq path (cdr path))))
 350         gnus-xmas-glyph-directory)))
 351
 352 (defun gnus-xmas-group-startup (&optional x y)
 353   "Insert startup message in current buffer."
 354   ;; Insert the message.
 355   (erase-buffer)
 356   (if (featurep 'xpm)
 357       (progn
 358         (set-glyph-property gnus-xmas-logo 'image  "~/tmp/gnus.xpm")
 359         (set-glyph-image gnus-xmas-logo "~/tmp/gnus.xpm" 'global 'x)
 360
 361         (insert " ")
 362         (set-extent-begin-glyph (make-extent (point) (point)) gnus-xmas-logo)
 363         (insert "
 364    Gnus * A newsreader for Emacsen
 365  A Praxis Release * larsi@ifi.uio.no")
 366         (goto-char (point-min))
 367         (while (not (eobp))
 368           (insert (make-string (/ (max (- (window-width) (or x 35)) 0) 2)
 369                                ? ))
 370           (forward-line 1))
 371         (goto-char (point-min))
 372         ;; +4 is fuzzy factor.
 373         (insert-char ?\n (/ (max (- (window-height) (or y 24)) 0) 2)))
 374
 375     (insert
 376      (format "
 377      %s
 378            A newsreader
 379       for GNU Emacs
 380
 381         Based on GNUS
 382              written by
 383      Masanobu UMEDA
 384
 385        A Praxis Release
 386       larsi@ifi.uio.no
 387 "
 388              gnus-version))
 389     ;; And then hack it.
 390     ;; 18 is the longest line.
 391     (indent-rigidly (point-min) (point-max)
 392                     (/ (max (- (window-width) (or x 28)) 0) 2))
 393     (goto-char (point-min))
 394     ;; +4 is fuzzy factor.
 395     (insert-char ?\n (/ (max (- (window-height) (or y 12)) 0) 2)))
 396
 397   ;; Fontify some.
 398   (goto-char (point-min))
 399   (search-forward "Praxis")
 400   (put-text-property (match-beginning 0) (match-end 0) 'face 'bold)
 401   (goto-char (point-min)))
 402
 403 ;;; The toolbar.
 404
 405 (defvar gnus-use-toolbar 'default-toolbar
 406   "*If nil, do not use a toolbar.
 407 If it is non-nil, it must be a toolbar.  The five legal values are
 408 `default-toolbar', `top-toolbar', `bottom-toolbar',
 409 `right-toolbar', and `left-toolbar'.")
 410
 411 (defvar gnus-group-toolbar
 412   '([gnus-group-exit-icon gnus-group-exit t "Exit Gnus"]
 413     [gnus-group-kill-group-icon gnus-group-kill-group t "Kill group"]
 414     [gnus-group-get-new-news-icon gnus-group-get-new-news t "Get new news"]
 415     [gnus-group-get-new-news-this-group-icon
 416      gnus-group-get-new-news-this-group t "Get new news in this group"]
 417     [gnus-group-catchup-current-icon
 418      gnus-group-catchup-current t "Catchup group"]
 419     [gnus-group-describe-group-icon
 420      gnus-group-describe-group t "Describe group"])
 421   "The group buffer toolbar.")
 422
 423 (defvar gnus-summary-toolbar
 424   '([gnus-summary-post-news-icon
 425      gnus-summary-post-news t "Post an article"]
 426     [gnus-summary-save-article-file-icon
 427      gnus-summary-save-article-file t "Save article in file"]
 428     [gnus-summary-save-article-icon
 429      gnus-summary-save-article t "Save article"]
 430     [gnus-summary-reply-icon
 431      gnus-summary-reply t "Mail a reply"]
 432     [gnus-summary-reply-with-original-icon
 433      gnus-summary-reply-with-original t "Mail a reply and yank the original"]
 434     [gnus-summary-followup-icon
 435      gnus-summary-followup t "Post a followup"]
 436     [gnus-summary-followup-with-original-icon
 437      gnus-summary-followup-with-original t
 438      "Post a followup and yank the original"]
 439     [gnus-uu-decode-uu-icon
 440      gnus-uu-decode-uu t "Decode uuencoded articles"]
 441     [gnus-uu-post-news-icon
 442      gnus-uu-post-news t "Post an uuencoded article"]
 443     [gnus-summary-caesar-message-icon
 444      gnus-summary-caesar-message t "Rot 13"]
 445     [gnus-summary-cancel-article-icon
 446      gnus-summary-cancel-article t "Cancel article"])
 447   "The summary buffer toolbar.")
 448
 449 (defun gnus-xmas-setup-toolbar (bar &optional force)
 450   (let ((dir (gnus-xmas-find-glyph-directory))
 451         icon up down disabled name)
 452     (if (not dir)
 453         ()
 454       (if (and (not force)
 455                (boundp (aref (car bar) 0)))
 456           dir
 457         (while bar
 458           (setq icon (aref (car bar) 0)
 459                 name (symbol-name icon)
 460                 bar (cdr bar))
 461           (setq up (concat dir name "-up.xpm"))
 462           (setq down (concat dir name "-down.xpm"))
 463           (setq disabled (concat dir name "-disabled.xpm"))
 464           (if (not (file-exists-p up))
 465               (set icon nil)
 466             (set icon (toolbar-make-button-list
 467                        up (and (file-exists-p down) down)
 468                        (and (file-exists-p disabled) disabled)))))
 469         dir))))
 470
 471 (defun gnus-xmas-setup-group-toolbar ()
 472   (and gnus-use-toolbar
 473        (gnus-xmas-setup-toolbar gnus-group-toolbar)
 474        (set-specifier (symbol-value gnus-use-toolbar)
 475                       (cons (current-buffer) gnus-group-toolbar))))
 476
 477 (defun gnus-xmas-setup-summary-toolbar ()
 478   (and gnus-use-toolbar
 479        (gnus-xmas-setup-toolbar gnus-summary-toolbar)
 480        (set-specifier (symbol-value gnus-use-toolbar)
 481                       (cons (current-buffer) gnus-summary-toolbar))))
 482
 483 ;;; gnus-xmas.el ends here