1 ;;; smiley-ems.el --- displaying smiley faces
3 ;; Copyright (C) 2000, 2001 Free Software Foundation, Inc.
5 ;; Author: Dave Love <fx@gnu.org>
6 ;; Keywords: news mail multimedia
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; A re-written, simplified version of Wes Hardaker's XEmacs smiley.el
28 ;; which might be merged back to smiley.el if we get an assignment for
29 ;; that. We don't have assignments for the images smiley.el uses, but
30 ;; I'm not sure we need that degree of rococoness and defaults like a
31 ;; yellow background. Also, using PBM means we can display the images
32 ;; more generally. -- fx
34 ;;; Test smileys: :-) :-\ :-( :-/
38 (eval-when-compile (require 'cl))
42 "Turn :-)'s into real images."
45 ;; Maybe this should go.
46 (defcustom smiley-data-directory (nnheader-find-etc-directory "smilies")
47 "*Location of the smiley faces files."
51 ;; The XEmacs version has a baroque, if not rococo, set of these.
52 (defcustom smiley-regexp-alist
53 '(("\\(:-?)\\)\\W" 1 "smile")
54 ("\\(;-?)\\)\\W" 1 "blink")
55 ("\\(:-]\\)\\W" 1 "forced")
56 ("\\(8-)\\)\\W" 1 "braindamaged")
57 ("\\(:-|\\)\\W" 1 "indifferent")
58 ("\\(:-[/\\]\\)\\W" 1 "wry")
59 ("\\(:-(\\)\\W" 1 "sad")
60 ("\\(:-{\\)\\W" 1 "frown"))
61 "*A list of regexps to map smilies to images.
62 The elements are (REGEXP MATCH FILE), where MATCH is the submatch in
63 regexp to replace with IMAGE. IMAGE is the name of a PBM file in
64 `smiley-data-directory'."
65 :type '(repeat (list regexp
66 (integer :tag "Regexp match number")
67 (string :tag "Image name")))
68 :set (lambda (symbol value)
69 (set-default symbol value)
70 (smiley-update-cache))
71 :initialize 'custom-initialize-default
74 (defcustom gnus-smiley-file-types
75 (let ((types (list "pbm")))
76 (when (gnus-image-type-available-p 'xpm)
79 "*List of suffixes on picon file names to try."
80 :type '(repeat string)
83 (defvar smiley-cached-regexp-alist nil)
85 (defun smiley-update-cache ()
86 (dolist (elt (if (symbolp smiley-regexp-alist)
87 (symbol-value smiley-regexp-alist)
89 (let ((types gnus-smiley-file-types)
91 (while (and (not file)
92 (setq type (pop types)))
93 (unless (file-exists-p
94 (setq file (expand-file-name (concat (nth 2 elt) "." type)
95 smiley-data-directory)))
98 (let ((image (find-image (list (list :type (intern type)
102 (push (list (car elt) (cadr elt) image)
103 smiley-cached-regexp-alist)))))))
105 (defvar smiley-active nil
106 "Non-nil means smilies in the buffer will be displayed.")
107 (make-variable-buffer-local 'smiley-active)
109 (defvar smiley-mouse-map
110 (let ((map (make-sparse-keymap)))
111 (define-key map [down-mouse-2] 'ignore) ; override widget
112 (define-key map [mouse-2]
113 'smiley-mouse-toggle-buffer)
116 (defun smiley-region (start end)
117 "Replace in the region `smiley-regexp-alist' matches with corresponding images.
118 A list of images is returned."
120 (when (and (fboundp 'display-graphic-p)
123 (if (eq 'smiley (overlay-get o 'smiley))
125 (overlays-in start end))
126 (unless smiley-cached-regexp-alist
127 (smiley-update-cache))
128 (setq smiley-active t)
130 (let ((beg (or start (point-min)))
131 group overlay image images)
132 (dolist (entry smiley-cached-regexp-alist)
133 (setq group (nth 1 entry)
136 (while (re-search-forward (car entry) end t)
140 (match-beginning group) (match-end group)
144 help-echo "mouse-2: toggle smilies in buffer"
145 keymap smiley-mouse-map)))))
148 (defun smiley-toggle-buffer (&optional arg)
149 "Toggle displaying smiley faces.
150 With arg, turn displaying on if and only if arg is positive."
153 (setq smiley-active (> arg 0))
154 (setq smiley-active (not smiley-active))))
156 (defun smiley-mouse-toggle-buffer (event)
157 "Toggle displaying smiley faces.
158 With arg, turn displaying on if and only if arg is positive."
161 (save-window-excursion
162 (mouse-set-point event)
163 (smiley-toggle-buffer))))
165 (eval-when-compile (defvar gnus-article-buffer))
167 (defun gnus-smiley-display (&optional arg)
168 "Display textual emoticaons (\"smilies\") as small graphical icons.
169 With arg, turn displaying on if and only if arg is positive."
171 (gnus-with-article-buffer
172 (if (memq 'smiley gnus-article-wash-types)
173 (gnus-delete-images 'smiley)
175 (let ((images (smiley-region (point) (point-max))))
177 (gnus-add-wash-type 'smiley)
178 (dolist (image images)
179 (gnus-add-image 'smiley image))))
180 (when (and (numberp arg)
182 (smiley-toggle-buffer arg)))))
186 ;;; smiley-ems.el ends here