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>.
43 (when (featurep 'xemacs)
44 (require 'annotations)
45 (require 'messagexmas)))
48 "Turn :-)'s into real images."
51 ;; FIXME: Where is the directory when using Emacs?
52 (defcustom smiley-data-directory
53 (if (featurep 'xemacs)
54 (message-xmas-find-glyph-directory "smilies")
55 "/usr/local/lib/xemacs/xemacs-packages/etc/smilies")
56 "*Location of the smiley faces files."
60 ;; Notice the subtle differences in the regular expressions in the
63 (defcustom smiley-deformed-regexp-alist
64 '(("\\(\\^_?\\^;;;\\)\\W" 1 "WideFaceAse3.xbm")
65 ("\\(\\^_?\\^;;\\)\\W" 1 "WideFaceAse2.xbm")
66 ("\\(\\^_?\\^;\\)\\W" 1 "WideFaceAse1.xbm")
67 ("\\(\\^_?\\^\\)\\W" 1 "WideFaceSmile.xbm")
68 ("\\(;_;\\)\\W" 1 "WideFaceWeep.xbm")
69 ("\\(T_T\\)\\W" 1 "WideFaceWeep.xbm")
70 ("\\(:-*[<«]+\\)\\W" 1 "FaceAngry.xpm")
71 ("\\(:-+\\]+\\)\\W" 1 "FaceGoofy.xpm")
72 ("\\(:-*D\\)\\W" 1 "FaceGrinning.xpm")
73 ("\\(:-*[)>}»]+\\)\\W" 1 "FaceHappy.xpm")
74 ("\\(=[)»]+\\)\\W" 1 "FaceHappy.xpm")
75 ("\\(:-*[/\\\"]\\)[^/]\\W" 1 "FaceIronic.xpm")
76 ("[^.0-9]\\([8|]-*[|Oo%]\\)\\W" 1 "FaceKOed.xpm")
77 ("\\([:|]-*#+\\)\\W" 1 "FaceNyah.xpm")
78 ("\\(:-*[({]+\\)\\W" 1 "FaceSad.xpm")
79 ("\\(=[({]+\\)\\W" 1 "FaceSad.xpm")
80 ("\\(:-*[Oo\*]\\)\\W" 1 "FaceStartled.xpm")
81 ("\\(:-*|\\)\\W" 1 "FaceStraight.xpm")
82 ("\\(:-*p\\)\\W" 1 "FaceTalking.xpm")
83 ("\\(:-*d\\)\\W" 1 "FaceTasty.xpm")
84 ("\\(;-*[>)}»]+\\)\\W" 1 "FaceWinking.xpm")
85 ("\\(:-*[Vvµ]\\)\\W" 1 "FaceWry.xpm")
86 ("\\([:|]-*P\\)\\W" 1 "FaceYukky.xpm"))
87 "*Normal and deformed faces for smilies."
88 :type '(repeat (list regexp
89 (integer :tag "Match")
90 (string :tag "Image")))
93 (defcustom smiley-nosey-regexp-alist
94 '(("\\(:-+[<«]+\\)\\W" 1 "FaceAngry.xpm")
95 ("\\(:-+\\]+\\)\\W" 1 "FaceGoofy.xpm")
96 ("\\(:-+D\\)\\W" 1 "FaceGrinning.xpm")
97 ("\\(:-+[}»]+\\)\\W" 1 "FaceHappy.xpm")
98 ("\\(:-*)+\\)\\W" 1 "FaceHappy.xpm")
99 ("\\(=[)]+\\)\\W" 1 "FaceHappy.xpm")
100 ("\\(:-+[/\\\"]+\\)\\W" 1 "FaceIronic.xpm")
101 ("\\([8|]-+[|Oo%]\\)\\W" 1 "FaceKOed.xpm")
102 ("\\([:|]-+#+\\)\\W" 1 "FaceNyah.xpm")
103 ("\\(:-+[({]+\\)\\W" 1 "FaceSad.xpm")
104 ("\\(=[({]+\\)\\W" 1 "FaceSad.xpm")
105 ("\\(:-+[Oo\*]\\)\\W" 1 "FaceStartled.xpm")
106 ("\\(:-+|\\)\\W" 1 "FaceStraight.xpm")
107 ("\\(:-+p\\)\\W" 1 "FaceTalking.xpm")
108 ("\\(:-+d\\)\\W" 1 "FaceTasty.xpm")
109 ("\\(;-+[>)}»]+\\)\\W" 1 "FaceWinking.xpm")
110 ("\\(:-+[Vvµ]\\)\\W" 1 "FaceWry.xpm")
111 ("\\(][:8B]-[)>]\\)\\W" 1 "FaceDevilish.xpm")
112 ("\\([:|]-+P\\)\\W" 1 "FaceYukky.xpm"))
113 "*Smileys with noses. These get less false matches."
114 :type '(repeat (list regexp
115 (integer :tag "Match")
116 (string :tag "Image")))
119 (defcustom smiley-regexp-alist smiley-deformed-regexp-alist
120 "*A list of regexps to map smilies to real images.
121 Defaults to the contents of `smiley-deformed-regexp-alist'.
122 An alternative is `smiley-nosey-regexp-alist' that matches less
124 If this is a symbol, take its value."
125 :type '(radio (variable-item smiley-deformed-regexp-alist)
126 (variable-item smiley-nosey-regexp-alist)
129 (integer :tag "Match")
130 (string :tag "Image"))))
133 (defcustom smiley-flesh-color "yellow"
138 (defcustom smiley-features-color "black"
143 (defcustom smiley-tongue-color "red"
148 (defcustom smiley-circle-color "black"
153 (defcustom smiley-mouse-face 'highlight
154 "*Face used for mouse highlighting in the smiley buffer.
156 Smiley buttons will be displayed in this face when the cursor is
161 (defvar smiley-glyph-cache nil)
163 (defvar smiley-map (make-sparse-keymap "smiley-keys")
164 "Keymap to toggle smiley states.")
166 (define-key smiley-map [(button2)] 'smiley-toggle-extent)
167 (define-key smiley-map [(button3)] 'smiley-popup-menu)
169 (defun smiley-popup-menu (e)
173 ["Toggle This Smiley" (smiley-toggle-extent ,e) t]
174 ["Toggle All Smilies" (smiley-toggle-extents ,e) t])))
176 (defun smiley-create-glyph (smiley pixmap)
178 (cdr-safe (assoc pixmap smiley-glyph-cache))
179 (let* ((xpm-color-symbols
181 (append `(("flesh" ,smiley-flesh-color)
182 ("features" ,smiley-features-color)
183 ("tongue" ,smiley-tongue-color))
187 (cons (if (featurep 'gtk) 'gtk 'x)
188 (expand-file-name pixmap smiley-data-directory))
190 (expand-file-name pixmap smiley-data-directory))
191 (cons 'tty smiley)))))
192 (setq smiley-glyph-cache (cons (cons pixmap glyph) smiley-glyph-cache))
193 (set-glyph-face glyph 'default)
196 (defun smiley-create-glyph-ems (smiley pixmap)
198 (create-image (expand-file-name pixmap smiley-data-directory))
203 (defun smiley-region (beg end)
204 "Smilify the region between point and mark."
206 (smiley-buffer (current-buffer) beg end))
208 (defun smiley-toggle-extent (event)
209 "Toggle smiley at given point."
211 (let* ((ant (event-glyph-extent event))
212 (pt (event-closest-point event))
214 (if (annotationp ant)
215 (when (extentp (setq ext (extent-property ant 'smiley-extent)))
216 (set-extent-property ext 'invisible nil)
217 (hide-annotation ant))
219 (while (setq ext (extent-at pt (event-buffer event) nil ext 'at))
220 (when (annotationp (setq ant
221 (extent-property ext 'smiley-annotation)))
222 (reveal-annotation ant)
223 (set-extent-property ext 'invisible t)))))))
226 (defun smiley-toggle-extent-ems (event)
227 "Toggle smiley at given point.
228 Note -- this function hasn't been implemented yet."
230 (error "This function hasn't been implemented yet.")
233 (defun smiley-toggle-extents (e)
238 (if (annotationp (setq ant (extent-property e 'smiley-annotation)))
239 (if (eq (extent-property e 'invisible) nil)
241 (reveal-annotation ant)
242 (set-extent-property e 'invisible t)
244 (hide-annotation ant)
245 (set-extent-property e 'invisible nil)))
250 (defun smiley-toggle-extents-ems (e)
252 (error "This function hasn't been implemented yet.")
256 (defun smiley-buffer (&optional buffer st nd)
258 (when (featurep '(or x gtk mswindows))
262 (let ((buffer-read-only nil)
263 (alist (if (symbolp smiley-regexp-alist)
264 (symbol-value smiley-regexp-alist)
265 smiley-regexp-alist))
266 (case-fold-search nil)
267 entry regexp beg group file)
270 (when (or (extent-property e 'smiley-extent)
271 (extent-property e 'smiley-annotation))
274 (goto-char (or st (point-min)))
276 ;; loop through alist
277 (while (setq entry (pop alist))
278 (setq regexp (car entry)
282 (while (re-search-forward regexp nd t)
283 (let* ((start (match-beginning group))
284 (end (match-end group))
285 (glyph (smiley-create-glyph (buffer-substring start end)
288 (mapcar 'delete-annotation (annotations-at end))
289 (let ((ext (make-extent start end))
290 (ant (make-annotation glyph end 'text)))
291 ;; set text extent params
292 (set-extent-property ext 'end-open t)
293 (set-extent-property ext 'start-open t)
294 (set-extent-property ext 'invisible t)
295 (set-extent-property ext 'keymap smiley-map)
296 (set-extent-property ext 'mouse-face smiley-mouse-face)
297 (set-extent-property ext 'intangible t)
298 ;; set annotation params
299 (set-extent-property ant 'mouse-face smiley-mouse-face)
300 (set-extent-property ant 'keymap smiley-map)
301 ;; remember each other
302 (set-extent-property ant 'smiley-extent ext)
303 (set-extent-property ext 'smiley-annotation ant)
307 "button2 toggles smiley, button3 pops up menu")
310 "button2 toggles smiley, button3 pops up menu")
311 (set-extent-property ext 'balloon-help
312 "Mouse button2 - toggle smiley
313 Mouse button3 - menu")
314 (set-extent-property ant 'balloon-help
315 "Mouse button2 - toggle smiley
316 Mouse button3 - menu"))
317 (when (smiley-end-paren-p start end)
318 (make-annotation ")" end 'text))
319 (goto-char end)))))))))
321 ;; FIXME: No popup menu, no customized color
322 (defun smiley-buffer-ems (&optional buffer st nd)
328 (let ((buffer-read-only nil)
329 (alist (if (symbolp smiley-regexp-alist)
330 (symbol-value smiley-regexp-alist)
331 smiley-regexp-alist))
332 (case-fold-search nil)
333 entry regexp beg group file)
334 (dolist (overlay (overlays-in (or st (point-min))
335 (or nd (point-max))))
336 (when (overlay-get overlay 'smiley)
337 (remove-text-properties (overlay-start overlay)
338 (overlay-end overlay) '(display))
339 (delete-overlay overlay)))
340 (goto-char (or st (point-min)))
342 ;; loop through alist
343 (while (setq entry (pop alist))
344 (setq regexp (car entry)
348 (while (re-search-forward regexp nd t)
349 (let* ((start (match-beginning group))
350 (end (match-end group))
351 (glyph (smiley-create-glyph nil file))
352 (overlay (make-overlay start end)))
354 (add-text-properties start end
356 (overlay-put overlay 'smiley glyph)
357 (goto-char end)))))))))
359 (defun smiley-end-paren-p (start end)
360 "Try to guess whether the current smiley is an end-paren smiley."
363 (when (and (re-search-backward "[()]" nil t)
364 (eq (char-after) ?\()
366 (or (not (re-search-forward "[()]" nil t))
367 (eq (char-after (1- (point))) ?\()))
370 (defun smiley-toggle-buffer (&optional arg buffer st nd)
371 "Toggle displaying smiley faces.
372 With arg, turn displaying on if and only if arg is positive."
378 (if (annotationp (setq ant (extent-property e 'smiley-annotation)))
379 (if (eq (extent-property e 'invisible) nil)
380 (setq off (cons (cons ant e) off))
381 (setq on (cons (cons ant e) on)))))
384 (if (and (not (and (numberp arg) (< arg 0)))
385 (or (and (numberp arg) (> arg 0))
389 (reveal-annotation (caar off))
390 (set-extent-property (cdar off) 'invisible t)
391 (setq off (cdr off)))
394 (hide-annotation (caar on))
395 (set-extent-property (cdar on) 'invisible nil)
396 (setq on (cdr on))))))
398 ;; Simply removing all smiley if existing.
399 ;; FIXME: make it work as the one in XEmacs.
400 (defun smiley-toggle-buffer-ems (&optional arg buffer st nd)
401 "Toggle displaying smiley faces.
402 With arg, turn displaying on if and only if arg is positive."
408 (dolist (overlay (overlays-in (or st (point-min))
409 (or nd (point-max))))
410 (when (overlay-get overlay 'smiley)
411 (remove-text-properties (overlay-start overlay)
412 (overlay-end overlay) '(display))
415 (smiley-buffer buffer st nd)))))
417 (unless (featurep 'xemacs)
418 (defalias 'smiley-create-glyph 'smiley-create-glyph-ems)
419 (defalias 'smiley-toggle-extent 'smiley-toggle-extent-ems)
420 (defalias 'smiley-toggle-extents 'smiley-toggle-extents-ems)
421 (defalias 'smiley-buffer 'smiley-buffer-ems)
422 (defalias 'smiley-toggle-buffer 'smiley-toggle-buffer-ems))
424 (defvar gnus-article-buffer)
426 (defun gnus-smiley-display (&optional arg)
427 "Display \"smileys\" as small graphical icons.
428 With arg, turn displaying on if and only if arg is positive."
431 (set-buffer gnus-article-buffer)
435 (let (buffer-read-only)
436 (smiley-toggle-buffer arg (current-buffer) (point) (point-max))))))
441 ;; coding: iso-8859-1
444 ;;; smiley.el ends here