*** empty log message ***
[gnus] / lisp / smiley.el
1 ;;; smiley.el --- displaying smiley faces
2 ;; Copyright (C) 1996 Free Software Foundation, Inc.
3
4 ;; Author: Wes Hardaker <hardaker@ece.ucdavis.edu>
5 ;; Keywords: fun
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 ;;
27 ;; comments go here.
28 ;;
29
30 ;;; Test smileys:  :-] :-o :-) ;-) :-\ :-| :-d :-P 8-| :-(
31
32 ;; To use:
33 ;; (require 'smiley)
34 ;; (add-hook 'gnus-article-display-hook 'gnus-smiley-display t)
35
36 ;; The smilies were drawn by Joe Reiss <joe@jreiss.async.vt.edu>. 
37
38 (require 'annotations)
39 (eval-when-compile (require 'cl))
40
41 (defvar smiley-data-directory (message-xmas-find-glyph-directory "smilies")
42   "Location of the smiley faces files.")
43
44 (defvar smiley-regexp-alist
45   '(("\\s-\\(:-*\\]\\)" 1 "FaceGrinning.xpm")
46     ("\\s-\\(:-*[oO]\\)" 1 "FaceStartled.xpm")
47     ("\\s-\\(:-*[)>]\\)" 1 "FaceHappy.xpm")
48     ("\\s-\\(;-*[>)]\\)" 1 "FaceWinking.xpm")
49     ("\\s-\\(:-[/\\]\\)" 1 "FaceIronic.xpm")
50     ("\\s-\\(:-*|\\)" 1 "FaceStraight.xpm")
51     ("\\s-\\(:-*<\\)" 1 "FaceAngry.xpm")
52     ("\\s-\\(:-*d\\)" 1 "FaceTasty.xpm")
53     ("\\s-\\(:-*[pP]\\)" 1 "FaceYukky.xpm")
54     ("\\s-\\(8-*|\\)" 1 "FaceKOed.xpm")
55     ("\\s-\\(:-*(\\)" 1 "FaceAngry.xpm"))
56   "A list of regexps to map smilies to real images.")
57
58 (defvar smiley-flesh-color "yellow"
59   "Flesh color.")
60
61 (defvar smiley-features-color "black"
62   "Features color.")
63
64 (defvar smiley-tongue-color "red"
65   "Tongue color.")
66
67 (defvar smiley-circle-color "black"
68   "Tongue color.")
69
70 (defvar smiley-glyph-cache nil)
71 (defvar smiley-running-xemacs (string-match "XEmacs" emacs-version))
72
73 (defun smiley-create-glyph (smiley pixmap)
74   (and
75    smiley-running-xemacs
76    (or
77     (cdr-safe (assoc pixmap smiley-glyph-cache))
78     (let* ((xpm-color-symbols 
79             (and (featurep 'xpm)
80                  (append `(("flesh" ,smiley-flesh-color)
81                            ("features" ,smiley-features-color)
82                            ("tongue" ,smiley-tongue-color))
83                          xpm-color-symbols)))
84            (glyph (make-glyph
85                    (list
86                     (cons 'x (expand-file-name pixmap smiley-data-directory))
87                     (cons 'tty smiley)))))
88       (setq smiley-glyph-cache (cons (cons pixmap glyph) smiley-glyph-cache))
89       (set-glyph-face glyph 'default)
90       glyph))))
91
92 ;;;###interactive
93 (defun smiley-region (beg end)
94   "Smilify the region between point and mark."
95   (interactive "r")
96   (smiley-buffer (current-buffer) beg end))
97
98 ;;;###interactive
99 (defun smiley-buffer (&optional buffer st nd)
100   (interactive)
101   (save-excursion
102     (and buffer (set-buffer buffer))
103     (let ((buffer-read-only nil)
104           (alist smiley-regexp-alist)
105           entry regexp beg group file)
106       (goto-char (or st (point-min)))
107       (setq beg (point))
108       ;; loop through alist
109       (while (setq entry (pop alist))
110         (setq regexp (car entry)
111               group (cadr entry)
112               file (caddr entry))
113         (goto-char beg)
114         (while (re-search-forward regexp nd t)
115           (let* ((start (match-beginning group))
116                  (end (match-end group))
117                  (glyph (smiley-create-glyph (buffer-substring start end)
118                                              file)))
119             (when glyph
120               (mapcar 'delete-annotation (annotations-at end))
121               (let ((ext (make-extent start end)))
122                 (set-extent-property ext 'invisible t)
123                 (set-extent-property ext 'end-open t)
124                 (set-extent-property ext 'intangible t))
125               (make-annotation glyph end 'text)
126               (when (smiley-end-paren-p start end)
127                 (make-annotation ")" end 'text))
128               (goto-char end))))))))
129
130 (defun smiley-end-paren-p (start end)
131   "Try to guess whether the current smiley is an end-paren smiley."
132   (save-excursion
133     (goto-char start)
134     (when (and (re-search-backward "[()]" nil t)
135                (= (following-char) ?\()
136                (goto-char end)
137                (or (not (re-search-forward "[()]" nil t))
138                    (= (char-after (1- (point))) ?\()))
139       t)))
140
141 ;;;###autoload    
142 (defun gnus-smiley-display ()
143   (interactive)
144   (save-excursion
145     (set-buffer gnus-article-buffer)
146     (goto-char (point-min))
147     ;; We skip the headers.
148     (unless (search-forward "\n\n" nil t)
149       (goto-char (point-max)))
150     (smiley-buffer (current-buffer) (point))))
151
152 (provide 'smiley)
153
154 ;;; smiley.el ends here