;;; gnus-picon.el --- displaying pretty icons in Gnus
-;; Copyright (C) 1996,97 Free Software Foundation, Inc.
+;; Copyright (C) 1996,97,98 Free Software Foundation, Inc.
;; Author: Wes Hardaker <hardaker@ece.ucdavis.edu>
;; Keywords: news xpm annotation glyph faces
:group 'picons)
(defcustom gnus-picons-has-modeline-p t
- "Wether the picons window should have a modeline.
+ "*Whether the picons window should have a modeline.
This is only useful if `gnus-picons-display-where' is `picons'."
:type 'boolean
:group 'picons)
(defcustom gnus-picons-database "/usr/local/faces"
- "Defines the location of the faces database.
+ "*Defines the location of the faces database.
For information on obtaining this database of pretty pictures, please
see http://www.cs.indiana.edu/picons/ftp/index.html"
:type 'directory
:group 'picons)
(defcustom gnus-picons-news-directories '("news")
- "Sub-directory of the faces database containing the icons for newsgroups."
+ "*List of directories to search for newsgroups faces."
:type '(repeat string)
:group 'picons)
(define-obsolete-variable-alias 'gnus-picons-news-directory
'gnus-picons-news-directories)
(defcustom gnus-picons-user-directories '("local" "users" "usenix" "misc")
- "List of directories to search for user faces."
+ "*List of directories to search for user faces."
:type '(repeat string)
:group 'picons)
(defcustom gnus-picons-domain-directories '("domains")
- "List of directories to search for domain faces.
+ "*List of directories to search for domain faces.
Some people may want to add \"unknown\" to this list."
:type '(repeat string)
:group 'picons)
(defcustom gnus-picons-refresh-before-display nil
- "If non-nil, display the article buffer before computing the picons."
+ "*If non-nil, display the article buffer before computing the picons."
:type 'boolean
:group 'picons)
+(defcustom gnus-picons-group-excluded-groups nil
+ "*If this regexp matches the group name, group picons will be disabled."
+ :type 'regexp
+ :group 'picons)
+
(defcustom gnus-picons-x-face-file-name
(format "/tmp/picon-xface.%s.xbm" (user-login-name))
- "The name of the file in which to store the converted X-face header."
+ "*The name of the file in which to store the converted X-face header."
:type 'string
:group 'picons)
(defcustom gnus-picons-convert-x-face (format "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | pbmtoxbm > %s" gnus-picons-x-face-file-name)
- "Command to convert the x-face header into a xbm file."
+ "*Command to convert the x-face header into a xbm file."
:type 'string
:group 'picons)
(when (featurep 'xpm)
(push "xpm" types))
types))
- "List of suffixes on picon file names to try."
+ "*List of suffixes on picon file names to try."
:type '(repeat string)
:group 'picons)
(defcustom gnus-picons-piconsearch-url nil
"*The url to query for picons. Setting this to nil will disable it.
-The only plublicly available address currently known is
+The only publicly available address currently known is
http://www.cs.indiana.edu:800/piconsearch. If you know of any other,
please tell me so that we can list it."
:type '(choice (const :tag "Disable" :value nil)
(string))
:group 'picons)
+(defface gnus-picons-xbm-face '((t (:foreground "black" :background "white")))
+ "Face to show X face"
+ :group 'picons)
+
;;; Internal variables:
(defvar gnus-picons-processes-alist nil
"Picons file names cache.
List of pairs (KEY . NAME) where KEY is (USER HOST DBS) and NAME is an URL.")
-(defvar gnus-group-annotations nil
- "List of annotations added/removed when selecting/exiting a group")
-(defvar gnus-article-annotations nil
- "List of annotations added/removed when selecting an article")
-(defvar gnus-x-face-annotations nil
- "List of annotations added/removed when selecting an article with an
-X-Face.")
-
(defvar gnus-picons-jobs-alist nil
"List of jobs that still need be done.
This is a list of (SYM-ANN TAG ARGS...) where SYM-ANN three annotations list,
;;; Functions:
-(defun gnus-picons-remove (symbol)
- "Remove all annotations in variable named SYMBOL.
-This function is careful to set it to nil before removing anything so that
-asynchronous process don't get crazy."
- (setq gnus-picons-jobs-alist (remassq symbol gnus-picons-jobs-alist))
- ;; notify running job that it may have been preempted
- (if (eq (car gnus-picons-job-already-running) symbol)
- (setq gnus-picons-job-already-running t))
- ;; clear all annotations
- (mapc (function (lambda (item)
- (if (annotationp item)
- (delete-annotation item))))
- (prog1 (symbol-value symbol)
- (set symbol nil))))
-
(defun gnus-picons-remove-all ()
"Removes all picons from the Gnus display(s)."
(interactive)
- (gnus-picons-remove 'gnus-article-annotations)
- (gnus-picons-remove 'gnus-group-annotations)
- (gnus-picons-remove 'gnus-x-face-annotations))
+ (map-extents (function (lambda (ext unused) (delete-annotation ext) nil))
+ nil nil nil nil nil 'gnus-picon)
+ (setq gnus-picons-jobs-alist '())
+ ;; notify running job that it may have been preempted
+ (if (and (listp gnus-picons-job-already-running)
+ gnus-picons-job-already-running)
+ (setq gnus-picons-job-already-running t)))
(defun gnus-get-buffer-name (variable)
"Returns the buffer name associated with the contents of a variable."
(list (list (current-buffer)
(cons nil gnus-picons-has-modeline-p)))))))
-(defun gnus-picons-prepare-for-annotations (annotations)
- "Prepare picons buffer for puting annotations memorized in ANNOTATIONS.
-ANNOTATIONS should be a symbol naming a variable wich contains a list of
-annotations. Sets buffer to `gnus-picons-display-where'."
+(defun gnus-picons-prepare-for-annotations ()
+ "Prepare picons buffer for putting annotations."
;; let drawing catch up
(when gnus-picons-refresh-before-display
(sit-for 0))
(gnus-picons-set-buffer)
- (gnus-picons-remove annotations))
+ (gnus-picons-remove-all))
-(defsubst gnus-picons-make-annotation (&rest args)
+(defun gnus-picons-make-annotation (&rest args)
(let ((annot (apply 'make-annotation args)))
- (set-extent-property annot 'duplicable nil)
+ (set-extent-property annot 'gnus-picon t)
+ (set-extent-property annot 'duplicable t)
annot))
(defun gnus-picons-article-display-x-face ()
"Display the x-face header bitmap in the 'gnus-picons-display-where buffer."
- ;; delete any old ones.
- ;; This is needed here because gnus-picons-display-x-face will not
- ;; be called if there is no X-Face header
- (gnus-picons-remove 'gnus-x-face-annotations)
- ;; display the new one.
(let ((gnus-article-x-face-command 'gnus-picons-display-x-face))
(gnus-article-display-x-face)))
(defun gnus-picons-x-face-sentinel (process event)
- (let* ((env (assq process gnus-picons-processes-alist))
- (annot (cdr env)))
- (setq gnus-picons-processes-alist (remassq process
- gnus-picons-processes-alist))
- (when annot
- (set-annotation-glyph annot
- (make-glyph gnus-picons-x-face-file-name))
- (if (memq annot gnus-x-face-annotations)
- (delete-file gnus-picons-x-face-file-name)))))
+ (when (memq process gnus-picons-processes-alist)
+ (setq gnus-picons-processes-alist
+ (delq process gnus-picons-processes-alist))
+ (gnus-picons-set-buffer)
+ (gnus-picons-make-annotation (make-glyph gnus-picons-x-face-file-name)
+ nil 'text)
+ (delete-file gnus-picons-x-face-file-name)))
(defun gnus-picons-display-x-face (beg end)
"Function to display the x-face header in the picons window.
(interactive)
(if (featurep 'xface)
;; Use builtin support
- (let ((buf (current-buffer)))
- (save-excursion
- (gnus-picons-prepare-for-annotations 'gnus-x-face-annotations)
- (setq gnus-x-face-annotations
- (cons (gnus-picons-make-annotation
- (vector 'xface
- :data (concat "X-Face: "
- (buffer-substring beg end buf)))
- nil 'text)
- gnus-x-face-annotations))))
+ (save-excursion
+ (gnus-picons-set-buffer)
+ (gnus-picons-make-annotation
+ (vector 'xface
+ :data (concat "X-Face: " (buffer-substring beg end)))
+ nil 'text))
;; convert the x-face header to a .xbm file
(let* ((process-connection-type nil)
- (annot (save-excursion
- (gnus-picons-prepare-for-annotations
- 'gnus-x-face-annotations)
- (gnus-picons-make-annotation nil nil 'text)))
(process (start-process-shell-command "gnus-x-face" nil
gnus-picons-convert-x-face)))
- (push annot gnus-x-face-annotations)
- (push (cons process annot) gnus-picons-processes-alist)
+ (push process gnus-picons-processes-alist)
(process-kill-without-query process)
(set-process-sentinel process 'gnus-picons-x-face-sentinel)
(process-send-region process beg end)
(process-send-eof process))))
(defun gnus-article-display-picons ()
- "Display faces for an author and his/her domain in gnus-picons-display-where."
+ "Display faces for an author and her domain in gnus-picons-display-where."
(interactive)
(let (from at-idx)
(when (and (featurep 'xpm)
(message-tokenize-header gnus-local-domain "."))
(message-tokenize-header (substring from (1+ at-idx))
"."))))
- (gnus-picons-prepare-for-annotations 'gnus-article-annotations)
- ;; if display in article buffer, the group annotations
- ;; wrongly placed. Move them here
- (if (eq gnus-picons-display-where 'article)
- (dolist (ext gnus-group-annotations)
- (set-extent-endpoints ext (point) (point))))
+ (gnus-picons-prepare-for-annotations)
+ (gnus-group-display-picons)
(if (null gnus-picons-piconsearch-url)
- (setq gnus-article-annotations
- (nconc gnus-article-annotations
- (gnus-picons-display-pairs
- (gnus-picons-lookup-pairs
- addrs gnus-picons-domain-directories)
- gnus-picons-display-as-address
- "." t)
- (if (and gnus-picons-display-as-address addrs)
- (list (gnus-picons-make-annotation
- [string :data "@"] nil
- 'text nil nil nil t)))
- (gnus-picons-display-picon-or-name
- (gnus-picons-lookup-user username addrs)
- username t)))
+ (progn
+ (gnus-picons-display-pairs (gnus-picons-lookup-pairs
+ addrs
+ gnus-picons-domain-directories)
+ gnus-picons-display-as-address
+ "." t)
+ (if (and gnus-picons-display-as-address addrs)
+ (gnus-picons-make-annotation
+ [string :data "@"] nil 'text nil nil nil t))
+ (gnus-picons-display-picon-or-name
+ (gnus-picons-lookup-user username addrs)
+ username t))
(push (list 'gnus-article-annotations 'search username addrs
gnus-picons-domain-directories t)
gnus-picons-jobs-alist)
- (gnus-picons-next-job))
-
- (add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all))))))
+ (gnus-picons-next-job)))))))
(defun gnus-group-display-picons ()
- "Display icons for the group in the gnus-picons-display-where buffer."
+ "Display icons for the group in the `gnus-picons-display-where' buffer."
(interactive)
(when (and (featurep 'xpm)
- (or (not (fboundp 'device-type)) (equal (device-type) 'x)))
+ (or (not (fboundp 'device-type)) (equal (device-type) 'x))
+ (or (null gnus-picons-group-excluded-groups)
+ (not (string-match gnus-picons-group-excluded-groups
+ gnus-newsgroup-name))))
(save-excursion
- (gnus-picons-prepare-for-annotations 'gnus-group-annotations)
+ (gnus-picons-prepare-for-annotations)
(if (null gnus-picons-piconsearch-url)
- (setq gnus-group-annotations
- (gnus-picons-display-pairs
- (gnus-picons-lookup-pairs (reverse (message-tokenize-header
- gnus-newsgroup-name "."))
- gnus-picons-news-directories)
- t "."))
+ (gnus-picons-display-pairs
+ (gnus-picons-lookup-pairs
+ (reverse (message-tokenize-header
+ (gnus-group-real-name gnus-newsgroup-name)
+ "."))
+ gnus-picons-news-directories)
+ t ".")
(push (list 'gnus-group-annotations 'search nil
- (message-tokenize-header gnus-newsgroup-name ".")
+ (message-tokenize-header
+ (gnus-group-real-name gnus-newsgroup-name) ".")
(if (listp gnus-picons-news-directories)
gnus-picons-news-directories
(list gnus-picons-news-directories))
(add-hook 'gnus-summary-exit-hook 'gnus-picons-remove-all))))
-(defsubst gnus-picons-lookup-internal (addrs dir)
+(defun gnus-picons-lookup-internal (addrs dir)
(setq dir (expand-file-name dir gnus-picons-database))
(gnus-picons-try-face (dolist (part (reverse addrs) dir)
(setq dir (expand-file-name part dir)))))
"Display picons in list PAIRS."
(let ((domain-p (and gnus-picons-display-as-address dot-p))
pair picons)
- (if (and bar-p domain-p right-p)
- (setq picons (gnus-picons-display-glyph
- (gnus-picons-try-face gnus-xmas-glyph-directory
- "bar.")
- nil right-p)))
- (while pairs
- (setq pair (pop pairs)
- picons (nconc picons
- (gnus-picons-display-picon-or-name (car pair)
- (cadr pair)
- right-p)
+ (when (and bar-p domain-p right-p)
+ (setq picons (gnus-picons-display-glyph
+ (let ((gnus-picons-file-suffixes '("xbm")))
+ (gnus-picons-try-face
+ gnus-xmas-glyph-directory "bar."))
+ nil right-p)))
+ (while (setq pair (pop pairs))
+ (setq picons (nconc picons
+ (gnus-picons-display-picon-or-name
+ (car pair) (cadr pair) right-p)
(if (and domain-p pairs)
(list (gnus-picons-make-annotation
(vector 'string :data dot-p)
nil 'text nil nil nil right-p))))))
- (if (and bar-p domain-p (not right-p))
- (setq picons (nconc picons
- (gnus-picons-display-glyph
- (gnus-picons-try-face gnus-xmas-glyph-directory
- "bar.")
- nil right-p))))
picons))
(defun gnus-picons-try-face (dir &optional filebase)
(key (concat dir filebase))
(glyph (cdr (assoc key gnus-picons-glyph-alist)))
(suffixes gnus-picons-file-suffixes)
- f)
- (while (and suffixes (null glyph))
- (when (file-exists-p (setq f (expand-file-name (concat filebase
- (pop suffixes))
- dir)))
- (setq glyph (make-glyph f))
+ f suf)
+ (while (setq suf (pop suffixes))
+ (when (file-exists-p (setq f (expand-file-name
+ (concat filebase suf)
+ dir)))
+ (setq suffixes nil
+ glyph (make-glyph f))
+ (when (equal suf "xbm")
+ (set-glyph-face glyph 'gnus-picons-xbm-face))
(push (cons key glyph) gnus-picons-glyph-alist)))
glyph))
(defun gnus-picons-display-glyph (glyph &optional part rightp)
- (let ((new (gnus-picons-make-annotation glyph (point)
- 'text nil nil nil rightp)))
+ (let ((new (gnus-picons-make-annotation
+ glyph (point) 'text nil nil nil rightp)))
(when (and part gnus-picons-display-as-address)
- (set-annotation-data new (cons new
- (make-glyph (vector 'string :data part))))
+ (set-annotation-data
+ new (cons new (make-glyph (vector 'string :data part))))
(set-annotation-action new 'gnus-picons-action-toggle))
(nconc
(list new)
(defun gnus-picons-network-display-internal (sym-ann glyph part right-p)
(gnus-picons-set-buffer)
- (set sym-ann (nconc (symbol-value sym-ann)
- (gnus-picons-display-picon-or-name glyph part right-p)))
+ (gnus-picons-display-picon-or-name glyph part right-p)
(gnus-picons-next-job-internal))
(defun gnus-picons-network-display-callback (url part sym-ann right-p)
(prog1 (gnus-picons-parse-filenames)
(kill-buffer (current-buffer)))))
+;; Initiate a query on the picon database
(defun gnus-picons-network-search (user addrs dbs sym-ann right-p)
(let* ((host (mapconcat 'identity addrs "."))
(key (list (or user "unknown") host (if user
(pop job)))
((eq 'bar tag)
(gnus-picons-network-display-internal
- sym-ann (gnus-picons-try-face gnus-xmas-glyph-directory
- "bar.")
+ sym-ann
+ (let ((gnus-picons-file-suffixes '("xbm")))
+ (gnus-picons-try-face
+ gnus-xmas-glyph-directory "bar."))
nil (pop job)))
((eq 'search tag);; (SYM-ANN 'search USER ADDRS DBS RIGHT-P)
(gnus-picons-network-search
projects / gnus / blobdiff