Merge Gnus' changes.
[emacs.git] / lisp / gnus / smiley.el
blob2f5c74220eae6d0bafb20aad4d2682841bfdae17
1 ;;; smiley.el --- displaying smiley faces
3 ;; Copyright (C) 2000-2011 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 3 of the License, or
13 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; A re-written, simplified version of Wes Hardaker's XEmacs smiley.el
26 ;; which might be merged back to smiley.el if we get an assignment for
27 ;; that. We don't have assignments for the images smiley.el uses, but
28 ;; I'm not sure we need that degree of rococoness and defaults like a
29 ;; yellow background. Also, using PBM means we can display the images
30 ;; more generally. -- fx
31 ;; `smiley.el' was replaced by `smiley-ems.el' on 2002-01-26 (after fx'
32 ;; comment).
34 ;; Test smileys:
35 ;; smile ^:-) ^:)
36 ;; blink ;-) ;)
37 ;; forced :-]
38 ;; braindamaged 8-)
39 ;; indifferent :-|
40 ;; wry :-/ :-\
41 ;; sad :-(
42 ;; frown :-{
43 ;; evil >:-)
44 ;; cry ;-(
45 ;; dead X-)
46 ;; grin :-D
48 ;;; Code:
50 (eval-when-compile (require 'cl))
51 (require 'nnheader)
52 (require 'gnus-art)
54 (defgroup smiley nil
55 "Turn :-)'s into real images."
56 :group 'gnus-visual)
58 (defvar smiley-data-directory)
60 (defcustom smiley-style
61 (if (or (and (fboundp 'face-attribute)
62 (>= (face-attribute 'default :height) 160))
63 (and (fboundp 'face-height)
64 (>= (face-height 'default) 14)))
65 'medium
66 'low-color)
67 "Smiley style."
68 :type '(choice (const :tag "small, 3 colors" low-color) ;; 13x14
69 (const :tag "medium, ~10 colors" medium) ;; 16x16
70 (const :tag "dull, grayscale" grayscale));; 14x14
71 :set (lambda (symbol value)
72 (set-default symbol value)
73 (setq smiley-data-directory (smiley-directory))
74 (smiley-update-cache))
75 :initialize 'custom-initialize-default
76 :version "23.1" ;; No Gnus
77 :group 'smiley)
79 ;; For compatibility, honor the variable `smiley-data-directory' if the user
80 ;; has set it.
82 (defun smiley-directory (&optional style)
83 "Return a the location of the smiley faces files.
84 STYLE specifies which style to use, see `smiley-style'. If STYLE
85 is nil, use `smiley-style'."
86 (unless style (setq style smiley-style))
87 (nnheader-find-etc-directory
88 (concat "images/smilies"
89 (cond ((eq smiley-style 'low-color) "")
90 ((eq smiley-style 'medium) "/medium")
91 ((eq smiley-style 'grayscale) "/grayscale")))))
93 (defcustom smiley-data-directory (smiley-directory)
94 "*Location of the smiley faces files."
95 :set (lambda (symbol value)
96 (set-default symbol value)
97 (smiley-update-cache))
98 :initialize 'custom-initialize-default
99 :type 'directory
100 :group 'smiley)
102 ;; The XEmacs version has a baroque, if not rococo, set of these.
103 (defcustom smiley-regexp-alist
104 '(("\\(;-)\\)\\W" 1 "blink")
105 ("[^;]\\(;)\\)\\W" 1 "blink")
106 ("\\(:-]\\)\\W" 1 "forced")
107 ("\\(8-)\\)\\W" 1 "braindamaged")
108 ("\\(:-|\\)\\W" 1 "indifferent")
109 ("\\(:-[/\\]\\)\\W" 1 "wry")
110 ("\\(:-(\\)\\W" 1 "sad")
111 ("\\(X-)\\)\\W" 1 "dead")
112 ("\\(:-{\\)\\W" 1 "frown")
113 ("\\(>:-)\\)\\W" 1 "evil")
114 ("\\(;-(\\)\\W" 1 "cry")
115 ("\\(:-D\\)\\W" 1 "grin")
116 ;; "smile" must be come after "evil"
117 ("\\(\\^?:-?)\\)\\W" 1 "smile"))
118 "*A list of regexps to map smilies to images.
119 The elements are (REGEXP MATCH IMAGE), where MATCH is the submatch in
120 regexp to replace with IMAGE. IMAGE is the name of an image file in
121 `smiley-data-directory'."
122 :version "24.1"
123 :type '(repeat (list regexp
124 (integer :tag "Regexp match number")
125 (string :tag "Image name")))
126 :set (lambda (symbol value)
127 (set-default symbol value)
128 (smiley-update-cache))
129 :initialize 'custom-initialize-default
130 :group 'smiley)
132 (defcustom gnus-smiley-file-types
133 (let ((types (list "pbm")))
134 (when (gnus-image-type-available-p 'xpm)
135 (push "xpm" types))
136 types)
137 "*List of suffixes on smiley file names to try."
138 :version "22.1"
139 :type '(repeat string)
140 :group 'smiley)
142 (defvar smiley-cached-regexp-alist nil)
144 (defun smiley-update-cache ()
145 (setq smiley-cached-regexp-alist nil)
146 (dolist (elt (if (symbolp smiley-regexp-alist)
147 (symbol-value smiley-regexp-alist)
148 smiley-regexp-alist))
149 (let ((types gnus-smiley-file-types)
150 file type)
151 (while (and (not file)
152 (setq type (pop types)))
153 (unless (file-exists-p
154 (setq file (expand-file-name (concat (nth 2 elt) "." type)
155 smiley-data-directory)))
156 (setq file nil)))
157 (when type
158 (let ((image (gnus-create-image file (intern type) nil
159 :ascent 'center)))
160 (when image
161 (push (list (car elt) (cadr elt) image)
162 smiley-cached-regexp-alist)))))))
164 ;; Not implemented:
165 ;; (defvar smiley-mouse-map
166 ;; (let ((map (make-sparse-keymap)))
167 ;; (define-key map [down-mouse-2] 'ignore) ; override widget
168 ;; (define-key map [mouse-2]
169 ;; 'smiley-mouse-toggle-buffer)
170 ;; map))
172 ;;;###autoload
173 (defun smiley-region (start end)
174 "Replace in the region `smiley-regexp-alist' matches with corresponding images.
175 A list of images is returned."
176 (interactive "r")
177 (when (gnus-graphic-display-p)
178 (unless smiley-cached-regexp-alist
179 (smiley-update-cache))
180 (save-excursion
181 (let ((beg (or start (point-min)))
182 group image images string)
183 (dolist (entry smiley-cached-regexp-alist)
184 (setq group (nth 1 entry)
185 image (nth 2 entry))
186 (goto-char beg)
187 (while (re-search-forward (car entry) end t)
188 (setq string (match-string group))
189 (goto-char (match-end group))
190 (delete-region (match-beginning group) (match-end group))
191 (when image
192 (push image images)
193 (gnus-add-wash-type 'smiley)
194 (gnus-add-image 'smiley image)
195 (gnus-put-image image string 'smiley))))
196 images))))
198 ;;;###autoload
199 (defun smiley-buffer (&optional buffer)
200 "Run `smiley-region' at the BUFFER, specified in the argument or
201 interactively. If there's no argument, do it at the current buffer."
202 (interactive "bBuffer to run smiley-region: ")
203 (save-excursion
204 (if buffer
205 (set-buffer (get-buffer buffer)))
206 (smiley-region (point-min) (point-max))))
208 (defun smiley-toggle-buffer (&optional arg)
209 "Toggle displaying smiley faces in article buffer.
210 With arg, turn displaying on if and only if arg is positive."
211 (interactive "P")
212 (gnus-with-article-buffer
213 (if (if (numberp arg)
214 (> arg 0)
215 (not (memq 'smiley gnus-article-wash-types)))
216 (smiley-region (point-min) (point-max))
217 (gnus-delete-images 'smiley))))
219 (defun smiley-mouse-toggle-buffer (event)
220 "Toggle displaying smiley faces.
221 With arg, turn displaying on if and only if arg is positive."
222 (interactive "e")
223 (save-excursion
224 (save-window-excursion
225 (mouse-set-point event)
226 (smiley-toggle-buffer))))
228 (provide 'smiley)
230 ;;; smiley.el ends here