*** empty log message ***
[gnus] / lisp / gnus-xmas.el
1 ;;; gnus-xmas.el --- Gnus functions for XEmacs
2 ;; Copyright (C) 1995,96,97 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 the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 (require 'text-props)
29 (defvar menu-bar-mode (featurep 'menubar))
30 (require 'messagexmas)
31
32 (defgroup gnus-xmas nil
33   "XEmacsoid support for Gnus"
34   :group 'gnus)
35
36 (defcustom gnus-xmas-glyph-directory nil
37   "*Directory where Gnus logos and icons are located.
38 If this variable is nil, Gnus will try to locate the directory
39 automatically."
40   :type '(choice (const :tag "autodetect" nil)
41                  directory)
42   :group 'gnus-xmas)
43
44 (defvar gnus-xmas-logo-color-alist
45   '((flame "#cc3300" "#ff2200")
46     (pine "#c0cc93" "#f8ffb8")
47     (moss "#a1cc93" "#d2ffb8")
48     (irish "#04cc90" "#05ff97")
49     (sky "#049acc" "#05deff")
50     (tin "#6886cc" "#82b6ff")
51     (velvet "#7c68cc" "#8c82ff")
52     (grape "#b264cc" "#cf7df")
53     (labia "#cc64c2" "#fd7dff")
54     (berry "#cc6485" "#ff7db5")
55     (neutral "#b4b4b4" "#878787")
56     (september "#bf9900" "#ffcc00"))
57   "Color alist used for the Gnus logo.")
58
59 (defcustom gnus-xmas-logo-color-style 'moss
60   "Color styles used for the Gnus logo."
61   :type '(choice (const flame) (const pine) (const moss)
62                  (const irish) (const sky) (const tin)
63                  (const velvet) (const grape) (const labia)
64                  (const berry) (const neutral) (const september))
65   :group 'gnus-xmas)
66
67 (defvar gnus-xmas-logo-colors
68   (cdr (assq gnus-xmas-logo-color-style gnus-xmas-logo-color-alist))
69   "Colors used for the Gnus logo.")
70
71 (defcustom gnus-article-x-face-command
72   (if (or (featurep 'xface)
73           (featurep 'xpm))
74       'gnus-xmas-article-display-xface
75     "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -")
76   "String or function to be executed to display an X-Face header.
77 If it is a string, the command will be executed in a sub-shell
78 asynchronously.  The compressed face will be piped to this command."
79   :type '(choice string function))
80
81 ;;; Internal variables.
82
83 ;; Don't warn about these undefined variables.
84
85 (defvar gnus-group-mode-hook)
86 (defvar gnus-summary-mode-hook)
87 (defvar gnus-article-mode-hook)
88
89 ;;defined in gnus.el
90 (defvar gnus-active-hashtb)
91 (defvar gnus-article-buffer)
92 (defvar gnus-auto-center-summary)
93 (defvar gnus-buffer-list)
94 (defvar gnus-current-headers)
95 (defvar gnus-level-killed)
96 (defvar gnus-level-zombie)
97 (defvar gnus-newsgroup-bookmarks)
98 (defvar gnus-newsgroup-dependencies)
99 (defvar gnus-newsgroup-selected-overlay)
100 (defvar gnus-newsrc-hashtb)
101 (defvar gnus-read-mark)
102 (defvar gnus-refer-article-method)
103 (defvar gnus-reffed-article-number)
104 (defvar gnus-unread-mark)
105 (defvar gnus-version)
106 (defvar gnus-view-pseudos)
107 (defvar gnus-view-pseudos-separately)
108 (defvar gnus-visual)
109 (defvar gnus-zombie-list)
110 ;;defined in gnus-msg.el
111 (defvar gnus-article-copy)
112 (defvar gnus-check-before-posting)
113 ;;defined in gnus-vis.el
114 (defvar gnus-article-button-face)
115 (defvar gnus-article-mouse-face)
116 (defvar gnus-summary-selected-face)
117 (defvar gnus-group-reading-menu)
118 (defvar gnus-group-group-menu)
119 (defvar gnus-group-misc-menu)
120 (defvar gnus-summary-article-menu)
121 (defvar gnus-summary-thread-menu)
122 (defvar gnus-summary-misc-menu)
123 (defvar gnus-summary-post-menu)
124 (defvar gnus-summary-kill-menu)
125 (defvar gnus-article-article-menu)
126 (defvar gnus-article-treatment-menu)
127 (defvar gnus-mouse-2)
128 (defvar standard-display-table)
129 (defvar gnus-tree-minimize-window)
130
131 (defun gnus-xmas-set-text-properties (start end props &optional buffer)
132   "You should NEVER use this function.  It is ideologically blasphemous.
133 It is provided only to ease porting of broken FSF Emacs programs."
134   (if (stringp buffer)
135       nil
136     (map-extents (lambda (extent ignored)
137                    (remove-text-properties
138                     start end
139                     (list (extent-property extent 'text-prop) nil)
140                     buffer)
141                    nil)
142                  buffer start end nil nil 'text-prop)
143     (gnus-add-text-properties start end props buffer)))
144
145 (defun gnus-xmas-highlight-selected-summary ()
146   ;; Highlight selected article in summary buffer
147   (when gnus-summary-selected-face
148     (when gnus-newsgroup-selected-overlay
149       (delete-extent gnus-newsgroup-selected-overlay))
150     (setq gnus-newsgroup-selected-overlay
151           (make-extent (gnus-point-at-bol) (gnus-point-at-eol)))
152     (set-extent-face gnus-newsgroup-selected-overlay
153                      gnus-summary-selected-face)))
154
155 (defcustom gnus-xmas-force-redisplay nil
156   "If non-nil, force a redisplay before recentering the summary buffer.
157 This is ugly, but it works around a bug in `window-displayed-height'."
158   :type 'boolean
159   :group 'gnus-xmas)
160
161 (defun gnus-xmas-switch-horizontal-scrollbar-off ()
162   (when (featurep 'scrollbar)
163     (set-specifier scrollbar-height (cons (current-buffer) 0))))
164
165 (defun gnus-xmas-summary-recenter ()
166   "\"Center\" point in the summary window.
167 If `gnus-auto-center-summary' is nil, or the article buffer isn't
168 displayed, no centering will be performed."
169   ;; Suggested by earle@mahendo.JPL.NASA.GOV (Greg Earle).
170   ;; Recenter only when requested.  Suggested by popovich@park.cs.columbia.edu.
171   ;; Force redisplay to get properly computed window height.
172   (when gnus-xmas-force-redisplay
173     (sit-for 0))
174   (when gnus-auto-center-summary
175     (let* ((height (if (fboundp 'window-displayed-height)
176                        (window-displayed-height)
177                      (- (window-height) 2)))
178            (top (cond ((< height 4) 0)
179                       ((< height 7) 1)
180                       (t 2)))
181            (bottom (save-excursion (goto-char (point-max))
182                                    (forward-line (- height))
183                                    (point)))
184            (window (get-buffer-window (current-buffer))))
185       (when (get-buffer-window gnus-article-buffer)
186         ;; Only do recentering when the article buffer is displayed,
187         ;; Set the window start to either `bottom', which is the biggest
188         ;; possible valid number, or the second line from the top,
189         ;; whichever is the least.
190         (set-window-start
191          window (min bottom (save-excursion (forward-line (- top)) (point)))))
192       ;; Do horizontal recentering while we're at it.
193       (when (and (get-buffer-window (current-buffer) t)
194                  (not (eq gnus-auto-center-summary 'vertical)))
195         (let ((selected (selected-window)))
196           (select-window (get-buffer-window (current-buffer) t))
197           (gnus-summary-position-point)
198           (gnus-horizontal-recenter)
199           (select-window selected))))))
200
201 (defun gnus-xmas-summary-set-display-table ()
202   ;; Setup the display table -- like `gnus-summary-setup-display-table',
203   ;; but done in an XEmacsish way.
204   (let ((table (make-display-table))
205         (i 32))
206     ;; Nix out all the control chars...
207     (while (>= (setq i (1- i)) 0)
208       (aset table i [??]))
209     ;; ... but not newline and cr, of course.  (cr is necessary for the
210     ;; selective display).
211     (aset table ?\n nil)
212     (aset table ?\r nil)
213     ;; We nix out any glyphs over 126 below ctl-arrow.
214     (let ((i (if (integerp ctl-arrow) ctl-arrow 160)))
215       (while (>= (setq i (1- i)) 127)
216         (unless (aref table i)
217           (aset table i [??]))))
218     ;; Can't use `set-specifier' because of a bug in 19.14 and earlier
219     (add-spec-to-specifier current-display-table table (current-buffer) nil)))
220
221 (defun gnus-xmas-add-text-properties (start end props &optional object)
222   (add-text-properties start end props object)
223   (put-text-property start end 'start-closed nil object))
224
225 (defun gnus-xmas-put-text-property (start end prop value &optional object)
226   (put-text-property start end prop value object)
227   (put-text-property start end 'start-closed nil object))
228
229 (defun gnus-xmas-extent-start-open (point)
230   (map-extents (lambda (extent arg)
231                  (set-extent-property extent 'start-open t))
232                nil point (min (1+ (point)) (point-max))))
233
234 (defun gnus-xmas-article-push-button (event)
235   "Check text under the mouse pointer for a callback function.
236 If the text under the mouse pointer has a `gnus-callback' property,
237 call it with the value of the `gnus-data' text property."
238   (interactive "e")
239   (set-buffer (window-buffer (event-window event)))
240   (let* ((pos (event-closest-point event))
241          (data (get-text-property pos 'gnus-data))
242          (fun (get-text-property pos 'gnus-callback)))
243     (when fun
244       (funcall fun data))))
245
246 (defun gnus-xmas-move-overlay (extent start end &optional buffer)
247   (set-extent-endpoints extent start end))
248
249 ;; Fixed by Christopher Davis <ckd@loiosh.kei.com>.
250 (defun gnus-xmas-article-add-button (