1 ;;; smiley.el --- displaying smiley faces
2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000
3 ;; Free Software Foundation, Inc.
5 ;; Author: Wes Hardaker <hardaker@ece.ucdavis.edu>
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.
31 ;;; Test smileys: :-] :-o :-) ;-) :-\ :-| :-d :-P 8-| :-(
35 ;; (setq gnus-treat-display-smileys t)
37 ;; The smilies were drawn by Joe Reiss <jreiss@vt.edu>.
39 (eval-when-compile (require 'cl))
41 (require 'annotations)
42 (require 'messagexmas)
46 "Turn :-)'s into real images (XEmacs)."
49 (defcustom smiley-data-directory (message-xmas-find-glyph-directory "smilies")
50 "*Location of the smiley faces files."
54 ;; Notice the subtle differences in the regular expressions in the
57 (defcustom smiley-deformed-regexp-alist
58 '(("\\(\\^_?\\^;;;\\)\\W" 1 "WideFaceAse3.xbm")
59 ("\\(\\^_?\\^;;\\)\\W" 1 "WideFaceAse2.xbm")
60 ("\\(\\^_?\\^;\\)\\W" 1 "WideFaceAse1.xbm")
61 ("\\(\\^_?\\^\\)\\W" 1 "WideFaceSmile.xbm")
62 ("\\(;_;\\)\\W" 1 "WideFaceWeep.xbm")
63 ("\\(T_T\\)\\W" 1 "WideFaceWeep.xbm")
64 ("\\(:-*[<
\e(I+
\e(B]+\\)\\W" 1 "FaceAngry.xpm")
65 ("\\(:-+\\]+\\)\\W" 1 "FaceGoofy.xpm")
66 ("\\(:-*D\\)\\W" 1 "FaceGrinning.xpm")
67 ("\\(:-*[)>}
\e(I;
\e(B]+\\)\\W" 1 "FaceHappy.xpm")
68 ("\\(=[)>
\e(I;
\e(B]+\\)\\W" 1 "FaceHappy.xpm")
69 ("\\(:-*[/\\\"]\\)[^/]\\W" 1 "FaceIronic.xpm")
70 ("[^.0-9]\\([8|]-*[|Oo%]\\)\\W" 1 "FaceKOed.xpm")
71 ("\\([:|]-*#+\\)\\W" 1 "FaceNyah.xpm")
72 ("\\(:-*[({]+\\)\\W" 1 "FaceSad.xpm")
73 ("\\(=[({]+\\)\\W" 1 "FaceSad.xpm")
74 ("\\(:-*[Oo\*]\\)\\W" 1 "FaceStartled.xpm")
75 ("\\(:-*|\\)\\W" 1 "FaceStraight.xpm")
76 ("\\(:-*p\\)\\W" 1 "FaceTalking.xpm")
77 ("\\(:-*d\\)\\W" 1 "FaceTasty.xpm")
78 ("\\(;-*[>)}
\e(I;
\e(B]+\\)\\W" 1 "FaceWinking.xpm")
79 ("\\(:-*[Vv
\e(I5
\e(B]\\)\\W" 1 "FaceWry.xpm")
80 ("\\([:|]-*P\\)\\W" 1 "FaceYukky.xpm"))
81 "*Normal and deformed faces for smilies."
82 :type '(repeat (list regexp
83 (integer :tag "Match")
84 (string :tag "Image")))
87 (defcustom smiley-nosey-regexp-alist
88 '(("\\(:-+[<
\e(I+
\e(B]+\\)\\W" 1 "FaceAngry.xpm")
89 ("\\(:-+\\]+\\)\\W" 1 "FaceGoofy.xpm")
90 ("\\(:-+D\\)\\W" 1 "FaceGrinning.xpm")
91 ("\\(:-+[}
\e(I;
\e(B]+\\)\\W" 1 "FaceHappy.xpm")
92 ("\\(:-*)+\\)\\W" 1 "FaceHappy.xpm")
93 ("\\(=[)]+\\)\\W" 1 "FaceHappy.xpm")
94 ("\\(:-+[/\\\"]+\\)\\W" 1 "FaceIronic.xpm")
95 ("\\([8|]-+[|Oo%]\\)\\W" 1 "FaceKOed.xpm")
96 ("\\([:|]-+#+\\)\\W" 1 "FaceNyah.xpm")
97 ("\\(:-+[({]+\\)\\W" 1 "FaceSad.xpm")
98 ("\\(=[({]+\\)\\W" 1 "FaceSad.xpm")
99 ("\\(:-+[Oo\*]\\)\\W" 1 "FaceStartled.xpm")
100 ("\\(:-+|\\)\\W" 1 "FaceStraight.xpm")
101 ("\\(:-+p\\)\\W" 1 "FaceTalking.xpm")
102 ("\\(:-+d\\)\\W" 1 "FaceTasty.xpm")
103 ("\\(;-+[>)}
\e(I;
\e(B]+\\)\\W" 1 "FaceWinking.xpm")
104 ("\\(:-+[Vv
\e(I5
\e(B]\\)\\W" 1 "FaceWry.xpm")
105 ("\\(][:8B]-[)>]\\)\\W" 1 "FaceDevilish.xpm")
106 ("\\([:|]-+P\\)\\W" 1 "FaceYukky.xpm"))
107 "*Smileys with noses. These get less false matches."
108 :type '(repeat (list regexp
109 (integer :tag "Match")
110 (string :tag "Image")))
113 (defcustom smiley-regexp-alist smiley-deformed-regexp-alist
114 "*A list of regexps to map smilies to real images.
115 Defaults to the contents of `smiley-deformed-regexp-alist'.
116 An alternative is `smiley-nosey-regexp-alist' that matches less
118 If this is a symbol, take its value."
119 :type '(radio (variable-item smiley-deformed-regexp-alist)
120 (variable-item smiley-nosey-regexp-alist)
123 (integer :tag "Match")
124 (string :tag "Image"))))
127 (defcustom smiley-flesh-color "yellow"
132 (defcustom smiley-features-color "black"
137 (defcustom smiley-tongue-color "red"
142 (defcustom smiley-circle-color "black"
147 (defcustom smiley-mouse-face 'highlight
148 "*Face used for mouse highlighting in the smiley buffer.
150 Smiley buttons will be displayed in this face when the cursor is
155 (defvar smiley-glyph-cache nil)
156 (defvar smiley-running-xemacs (string-match "XEmacs" emacs-version))
158 (defvar smiley-map (make-sparse-keymap "smiley-keys")
159 "Keymap to toggle smiley states.")
161 (define-key smiley-map [(button2)] 'smiley-toggle-extent)
162 (define-key smiley-map [(button3)] 'smiley-popup-menu)
164 (defun smiley-popup-menu (e)
168 ["Toggle This Smiley" (smiley-toggle-extent ,e) t]
169 ["Toggle All Smilies" (smiley-toggle-extents ,e) t])))
171 (defun smiley-create-glyph (smiley pixmap)
173 smiley-running-xemacs
175 (cdr-safe (assoc pixmap smiley-glyph-cache))
176 (let* ((xpm-color-symbols
178 (append `(("flesh" ,smiley-flesh-color)
179 ("features" ,smiley-features-color)
180 ("tongue" ,smiley-tongue-color))
184 (cons (if (featurep 'gtk) 'gtk 'x)
185 (expand-file-name pixmap smiley-data-directory))
187 (expand-file-name pixmap smiley-data-directory))
188 (cons 'tty smiley)))))
189 (setq smiley-glyph-cache (cons (cons pixmap glyph) smiley-glyph-cache))
190 (set-glyph-face glyph 'default)
194 (defun smiley-region (beg end)
195 "Smilify the region between point and mark."
197 (smiley-buffer (current-buffer) beg end))
199 (defun smiley-toggle-extent (event)
200 "Toggle smiley at given point."
202 (let* ((ant (event-glyph-extent event))
203 (pt (event-closest-point event))
205 (if (annotationp ant)
206 (when (extentp (setq ext (extent-property ant 'smiley-extent)))
207 (set-extent-property ext 'invisible nil)
208 (hide-annotation ant))
210 (while (setq ext (extent-at pt (event-buffer event) nil ext 'at))
211 (when (annotationp (setq ant
212 (extent-property ext 'smiley-annotation)))
213 (reveal-annotation ant)
214 (set-extent-property ext 'invisible t)))))))
216 (defun smiley-toggle-extents (e)
221 (if (annotationp (setq ant (extent-property e 'smiley-annotation)))
222 (if (eq (extent-property e 'invisible) nil)
224 (reveal-annotation ant)
225 (set-extent-property e 'invisible t)
227 (hide-annotation ant)
228 (set-extent-property e 'invisible nil)))
233 (defun smiley-buffer (&optional buffer st nd)
235 (when (featurep '(or x gtk mswindows))
239 (let ((buffer-read-only nil)
240 (alist (if (symbolp smiley-regexp-alist)
241 (symbol-value smiley-regexp-alist)
242 smiley-regexp-alist))
243 (case-fold-search nil)
244 entry regexp beg group file)
247 (when (or (extent-property e 'smiley-extent)
248 (extent-property e 'smiley-annotation))
251 (goto-char (or st (point-min)))
253 ;; loop through alist
254 (while (setq entry (pop alist))
255 (setq regexp (car entry)
259 (while (re-search-forward regexp nd t)
260 (let* ((start (match-beginning group))
261 (end (match-end group))
262 (glyph (smiley-create-glyph (buffer-substring start end)
265 (mapcar 'delete-annotation (annotations-at end))
266 (let ((ext (make-extent start end))
267 (ant (make-annotation glyph end 'text)))
268 ;; set text extent params
269 (set-extent-property ext 'end-open t)
270 (set-extent-property ext 'start-open t)
271 (set-extent-property ext 'invisible t)
272 (set-extent-property ext 'keymap smiley-map)
273 (set-extent-property ext 'mouse-face smiley-mouse-face)
274 (set-extent-property ext 'intangible t)
275 ;; set annotation params
276 (set-extent-property ant 'mouse-face smiley-mouse-face)
277 (set-extent-property ant 'keymap smiley-map)
278 ;; remember each other
279 (set-extent-property ant 'smiley-extent ext)
280 (set-extent-property ext 'smiley-annotation ant)
284 "button2 toggles smiley, button3 pops up menu")
287 "button2 toggles smiley, button3 pops up menu")
288 (set-extent-property ext 'balloon-help
289 "Mouse button2 - toggle smiley
290 Mouse button3 - menu")
291 (set-extent-property ant 'balloon-help
292 "Mouse button2 - toggle smiley
293 Mouse button3 - menu"))
294 (when (smiley-end-paren-p start end)
295 (make-annotation ")" end 'text))
296 (goto-char end)))))))))
298 (defun smiley-end-paren-p (start end)
299 "Try to guess whether the current smiley is an end-paren smiley."
302 (when (and (re-search-backward "[()]" nil t)
303 (eq (char-after) ?\()
305 (or (not (re-search-forward "[()]" nil t))
306 (eq (char-after (1- (point))) ?\()))
309 (defun smiley-toggle-buffer (&optional arg buffer st nd)
310 "Toggle displaying smiley faces.
311 With arg, turn displaying on if and only if arg is positive."
317 (if (annotationp (setq ant (extent-property e 'smiley-annotation)))
318 (if (eq (extent-property e 'invisible) nil)
319 (setq off (cons (cons ant e) off))
320 (setq on (cons (cons ant e) on)))))
323 (if (and (not (and (numberp arg) (< arg 0)))
324 (or (and (numberp arg) (> arg 0))
328 (reveal-annotation (caar off))
329 (set-extent-property (cdar off) 'invisible t)
330 (setq off (cdr off)))
333 (hide-annotation (caar on))
334 (set-extent-property (cdar on) 'invisible nil)
335 (setq on (cdr on))))))
337 (defvar gnus-article-buffer)
339 (defun gnus-smiley-display (&optional arg)
340 "Display \"smileys\" as small graphical icons.
341 With arg, turn displaying on if and only if arg is positive."
344 (set-buffer gnus-article-buffer)
348 (smiley-toggle-buffer arg (current-buffer) (point) (point-max)))))
353 ;; coding: iso-8859-1
356 ;;; smiley.el ends here