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

   1 ;;; gnus-xmas.el --- Gnus functions for XEmacs
   2 ;; Copyright (C) 1995,96 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 (defun gnus-xmas-read-event-char ()
 228   "Get the next event."
 229   (let ((event (next-event)))
 230     ;; We junk all non-key events.  Is this naughty?
 231     (while (not (key-press-event-p event))
 232       (setq event (next-event)))
 233     (cons (and (key-press-event-p event)
 234                (numberp (event-key event))
 235                (event-to-character event))
 236           event)))
 237
 238 (defun gnus-xmas-seconds-since-epoch (date)
 239   "Return a floating point number that says how many seconds have lapsed between Jan 1 12:00:00 1970 and DATE."
 240   (let* ((tdate (mapcar (lambda (ti) (and ti (string-to-int ti)))
 241                         (timezone-parse-date date)))
 242          (ttime (mapcar (lambda (ti) (and ti (string-to-int ti)))
 243                         (timezone-parse-time
 244                          (aref (timezone-parse-date date) 3))))
 245          (edate (mapcar (lambda (ti) (and ti (string-to-int ti)))
 246                         (timezone-parse-date "Jan 1 12:00:00 1970")))
 247          (tday (- (timezone-absolute-from-gregorian
 248                    (nth 1 tdate) (nth 2 tdate) (nth 0 tdate))
 249                   (timezone-absolute-from-gregorian
 250                    (nth 1 edate) (nth 2 edate) (nth 0 edate)))))
 251     (+ (nth 2 ttime)
 252        (* (nth 1 ttime) 60)
 253        (* (float (nth 0 ttime)) 60 60)
 254        (* (float tday) 60 60 24))))
 255
 256 (defun gnus-xmas-define ()
 257   (setq gnus-mouse-2 [button2])
 258
 259   (or (memq 'underline (list-faces))
 260       (and (fboundp 'make-face)
 261            (funcall (intern "make-face") 'underline)))
 262   ;; Must avoid calling set-face-underline-p directly, because it
 263   ;; is a defsubst in emacs19, and will make the .elc files non
 264   ;; portable!
 265   (or (face-differs-from-default-p 'underline)
 266       (funcall (intern "set-face-underline-p") 'underline t))
 267
 268   (fset 'gnus-make-overlay 'make-extent)
 269   (fset 'gnus-overlay-put 'set-extent-property)
 270   (fset 'gnus-move-overlay 'gnus-xmas-move-overlay)
 271
 272   (fset 'set-text-properties 'gnus-xmas-set-text-properties)
 273
 274   (or (boundp 'standard-display-table) (setq standard-display-table nil))
 275
 276   (defvar gnus-mouse-face-prop 'highlight)
 277
 278   (unless (fboundp 'encode-time)
 279     (defun encode-time (sec minute hour day month year &optional zone)
 280       (let ((seconds
 281              (gnus-xmas-seconds-since-epoch
 282               (timezone-make-arpa-date
 283                year month day (timezone-make-time-string hour minute sec)
 284                zone))))
 285         (list (floor (/ seconds (expt 2 16)))
 286               (round (mod seconds (expt 2 16)))))))
 287
 288   (defun gnus-byte-code (func)
 289     "Return a form that can be `eval'ed based on FUNC."
 290     (let ((fval (symbol-function func)))
 291       (if (byte-code-function-p fval)
 292           (list 'funcall fval)
 293         (cons 'progn (cdr (cdr fval))))))
 294
 295   ;; Fix by "jeff (j.d.) sparkes" <jsparkes@bnr.ca>.
 296   (defvar gnus-display-type (device-class)
 297     "A symbol indicating the display Emacs is running under.
 298 The symbol should be one of `color', `grayscale' or `mono'. If Emacs
 299 guesses this display attribute wrongly, either set this variable in
 300 your `~/.emacs' or set the resource `Emacs.displayType' in your
 301 `~/.Xdefaults'. See also `gnus-background-mode'.
 302
 303 This is a meta-variable that will affect what default values other
 304 variables get.  You would normally not change this variable, but
 305 pounce directly on the real variables themselves.")
 306
 307
 308   (or (fboundp 'x-color-values)
 309       (fset 'x-color-values
 310             (lambda (color)
 311               (color-instance-rgb-components
 312                (make-color-instance color)))))
 313
 314   (defvar gnus-background-mode
 315     (let ((bg-resource
 316            (condition-case ()
 317                (x-get-resource ".backgroundMode" "BackgroundMode" 'string)
 318              (error nil)))
 319           (params (frame-parameters)))
 320       (cond (bg-resource (intern (downcase bg-resource)))
 321             ((and (assq 'background-color params)
 322                   (< (apply '+ (x-color-values
 323                                 (cdr (assq 'background-color params))))
 324                      (/ (apply '+ (x-color-values "white")) 3)))
 325              'dark)
 326             (t 'light)))
 327     "A symbol indicating the Emacs background brightness.
 328 The symbol should be one of `light' or `dark'.
 329 If Emacs guesses this frame attribute wrongly, either set this variable in
 330 your `~/.emacs' or set the resource `Emacs.backgroundMode' in your
 331 `~/.Xdefaults'.
 332 See also `gnus-display-type'.
 333
 334 This is a meta-variable that will affect what default values other
 335 variables get.  You would normally not change this variable, but
 336 pounce directly on the real variables themselves.")
 337   )
 338
 339
 340
 341 (defun gnus-xmas-redefine ()
 342   "Redefine lots of Gnus functions for XEmacs."
 343   (fset 'gnus-summary-make-display-table (lambda () nil))
 344   (fset 'gnus-visual-turn-off-edit-menu 'identity)
 345   (fset 'gnus-highlight-selected-summary
 346         'gnus-xmas-highlight-selected-summary)
 347   (fset 'gnus-summary-recenter 'gnus-xmas-summary-recenter)
 348   (fset 'gnus-group-remove-excess-properties
 349         'gnus-xmas-group-remove-excess-properties)
 350   (fset 'gnus-copy-article-buffer 'gnus-xmas-copy-article-buffer)
 351   (fset 'gnus-article-push-button 'gnus-xmas-article-push-button)
 352   (fset 'gnus-article-add-button 'gnus-xmas-article-add-button)
 353   (fset 'gnus-window-top-edge 'gnus-xmas-window-top-edge)
 354   (fset 'set-text-properties 'gnus-xmas-set-text-properties)
 355   (fset 'gnus-read-event-char 'gnus-xmas-read-event-char)
 356   (fset 'gnus-group-startup-message 'gnus-xmas-group-startup-message)
 357
 358   (or (fboundp 'appt-select-lowest-window)
 359       (fset 'appt-select-lowest-window
 360             'gnus-xmas-appt-select-lowest-window))
 361
 362   (add-hook 'gnus-group-mode-hook 'gnus-xmas-group-menu-add)
 363   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-summary-menu-add)
 364   (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add)
 365
 366   (add-hook 'gnus-group-mode-hook 'gnus-xmas-setup-group-toolbar)
 367   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-setup-summary-toolbar))
 368
 369
 370 ;;; XEmacs logo and toolbar.
 371
 372 (defun gnus-xmas-find-glyph-directory ()
 373   (or gnus-xmas-glyph-directory ; We have a dir already...
 374       (let ((path load-path)
 375             dir)
 376         ;; We try to find the dir by looking at the load path,
 377         ;; stripping away the last component and adding "etc/".
 378         (while path
 379           (setq dir (concat
 380                      (file-name-directory (directory-file-name (car path)))
 381                      "etc/"))
 382           (if (and (file-exists-p dir)
 383                    (file-directory-p dir)
 384                    (file-exists-p (concat dir "gnus-group-exit-icon-up.xpm")))
 385               (setq gnus-xmas-glyph-directory dir
 386                     path nil)
 387             (setq path (cdr path))))
 388         gnus-xmas-glyph-directory)))
 389
 390 (defun gnus-xmas-group-startup-message (&optional x y)
 391   "Insert startup message in current buffer."
 392   ;; Insert the message.
 393   (gnus-xmas-find-glyph-directory)
 394   (erase-buffer)
 395   (let ((file (and gnus-xmas-glyph-directory
 396                    (concat
 397                     (file-name-as-directory gnus-xmas-glyph-directory)
 398                     "gnus.xpm"))))
 399     (if (and (featurep 'xpm)
 400              (not (equal (device-type) 'tty))
 401              file (file-exists-p file))
 402         (progn
 403           (set-glyph-property gnus-xmas-logo 'image file)
 404           (set-glyph-image gnus-xmas-logo file 'global 'x)
 405
 406           (insert " ")
 407           (set-extent-begin-glyph (make-extent (point) (point)) gnus-xmas-logo)
 408           (goto-char (point-min))
 409           (while (not (eobp))
 410             (insert (make-string (/ (max (- (window-width) (or x 35)) 0) 2)
 411                                  ? ))
 412             (forward-line 1))
 413           (goto-char (point-min))
 414           (let* ((pheight (+ 20 (count-lines (point-min) (point-max))))
 415                  (wheight (window-height))
 416                  (rest (- wheight pheight)))
 417             (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n))))
 418
 419       (insert
 420        (format "              %s
 421           _    ___ _             _
 422           _ ___ __ ___  __    _ ___
 423           __   _     ___    __  ___
 424               _           ___     _
 425              _  _ __             _
 426              ___   __            _
 427                    __           _
 428                     _      _   _
 429                    _      _    _
 430                       _  _    _
 431                   __  ___
 432                  _   _ _     _
 433                 _   _
 434               _    _
 435              _    _
 436             _
 437           __
 438
 439 "
 440                ""))
 441       ;; And then hack it.
 442       (gnus-indent-rigidly (point-min) (point-max)
 443                            (/ (max (- (window-width) (or x 46)) 0) 2))
 444       (goto-char (point-min))
 445       (forward-line 1)
 446       (let* ((pheight (count-lines (point-min) (point-max)))
 447              (wheight (window-height))
 448              (rest (- wheight pheight)))
 449         (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n))))
 450     ;; Fontify some.
 451     (goto-char (point-min))
 452     (and (search-forward "Praxis" nil t)
 453          (put-text-property (match-beginning 0) (match-end 0) 'face 'bold))
 454     (goto-char (point-min))
 455     (let* ((mode-string (gnus-group-set-mode-line)))
 456       (setq mode-line-buffer-identification
 457             (list (concat gnus-version (substring (car mode-string) 4))))
 458       (set-buffer-modified-p t))))
 459
 460
 461 ;;; The toolbar.
 462
 463 (defvar gnus-use-toolbar 'default-toolbar
 464   "*If nil, do not use a toolbar.
 465 If it is non-nil, it must be a toolbar.  The five legal values are
 466 `default-toolbar', `top-toolbar', `bottom-toolbar',
 467 `right-toolbar', and `left-toolbar'.")
 468
 469 (defvar gnus-group-toolbar
 470   '([gnus-group-exit-icon gnus-group-exit t "Exit Gnus"]
 471     [gnus-group-kill-group-icon gnus-group-kill-group t "Kill group"]
 472     [gnus-group-get-new-news-icon gnus-group-get-new-news t "Get new news"]
 473     [gnus-group-get-new-news-this-group-icon
 474      gnus-group-get-new-news-this-group t "Get new news in this group"]
 475     [gnus-group-catchup-current-icon
 476      gnus-group-catchup-current t "Catchup group"]
 477     [gnus-group-describe-group-icon
 478      gnus-group-describe-group t "Describe group"])
 479   "The group buffer toolbar.")
 480
 481 (defvar gnus-summary-toolbar
 482   '([gnus-summary-post-news-icon
 483      gnus-summary-post-news t "Post an article"]
 484     [gnus-summary-save-article-file-icon
 485      gnus-summary-save-article-file t "Save article in file"]
 486     [gnus-summary-save-article-icon
 487      gnus-summary-save-article t "Save article"]
 488     [gnus-summary-reply-icon
 489      gnus-summary-reply t "Mail a reply"]
 490     [gnus-summary-reply-with-original-icon
 491      gnus-summary-reply-with-original t "Mail a reply and yank the original"]
 492     [gnus-summary-followup-icon
 493      gnus-summary-followup t "Post a followup"]
 494     [gnus-summary-followup-with-original-icon
 495      gnus-summary-followup-with-original t
 496      "Post a followup and yank the original"]
 497     [gnus-uu-decode-uu-icon
 498      gnus-uu-decode-uu t "Decode uuencoded articles"]
 499     [gnus-uu-post-news-icon
 500      gnus-uu-post-news t "Post an uuencoded article"]
 501     [gnus-summary-caesar-message-icon
 502      gnus-summary-caesar-message t "Rot 13"]
 503     [gnus-summary-cancel-article-icon
 504      gnus-summary-cancel-article t "Cancel article"])
 505   "The summary buffer toolbar.")
 506
 507 (defun gnus-xmas-setup-toolbar (bar &optional force)
 508   (let ((dir (gnus-xmas-find-glyph-directory))
 509         icon up down disabled name)
 510     (if (not dir)
 511         ()
 512       (if (and (not force)
 513                (boundp (aref (car bar) 0)))
 514           dir
 515         (while bar
 516           (setq icon (aref (car bar) 0)
 517                 name (symbol-name icon)
 518                 bar (cdr bar))
 519           (setq up (concat dir name "-up.xpm"))
 520           (setq down (concat dir name "-down.xpm"))
 521           (setq disabled (concat dir name "-disabled.xpm"))
 522           (if (not (file-exists-p up))
 523               (set icon nil)
 524             (set icon (toolbar-make-button-list
 525                        up (and (file-exists-p down) down)
 526                        (and (file-exists-p disabled) disabled)))))
 527         dir))))
 528
 529 (defun gnus-xmas-setup-group-toolbar ()
 530   (and gnus-use-toolbar
 531        (gnus-xmas-setup-toolbar gnus-group-toolbar)
 532        (set-specifier (symbol-value gnus-use-toolbar)
 533                       (cons (current-buffer) gnus-group-toolbar))))
 534
 535 (defun gnus-xmas-setup-summary-toolbar ()
 536   (and gnus-use-toolbar
 537        (gnus-xmas-setup-toolbar gnus-summary-toolbar)
 538        (set-specifier (symbol-value gnus-use-toolbar)
 539                       (cons (current-buffer) gnus-summary-toolbar))))
 540
 541 ;;; gnus-xmas.el ends here