cgit.sxemacs.org Git - gnus/blob - lisp/smiley.el

   1 ;;; smiley.el --- displaying smiley faces
   2 ;; Copyright (C) 1996,97,98 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 <jreiss@vt.edu>.
  37
  38 (require 'annotations)
  39 (require 'messagexmas)
  40 (require 'cl)
  41 (require 'custom)
  42
  43 (defgroup smiley nil
  44   "Turn :-)'s into real images (XEmacs)."
  45   :group 'gnus-visual)
  46
  47 (defcustom smiley-data-directory (message-xmas-find-glyph-directory "smilies")
  48   "*Location of the smiley faces files."
  49   :type 'directory
  50   :group 'smiley)
  51
  52 ;; Notice the subtle differences in the regular expressions in the
  53 ;; two alists below.
  54
  55 (defcustom smiley-deformed-regexp-alist
  56   '(("\\(\\^_?\\^;;;\\)\\W" 1 "WideFaceAse3.xbm")
  57     ("\\(\\^_?\\^;;\\)\\W" 1 "WideFaceAse2.xbm")
  58     ("\\(\\^_?\\^;\\)\\W" 1 "WideFaceAse1.xbm")
  59     ("\\(\\^_?\\^\\)\\W" 1 "WideFaceSmile.xbm")
  60     ("\\(;_;\\)\\W" 1 "WideFaceWeep.xbm")
  61     ("\\(T_T\\)\\W" 1 "WideFaceWeep.xbm")
  62     ("\\(:-*[<«]+\\)\\W" 1 "FaceAngry.xpm")
  63     ("\\(:-+\\]+\\)\\W" 1 "FaceGoofy.xpm")
  64     ("\\(:-*D\\)\\W" 1 "FaceGrinning.xpm")
  65     ("\\(:-*[)>}»]+\\)\\W" 1 "FaceHappy.xpm")
  66     ("\\(=[)>»]+\\)\\W" 1 "FaceHappy.xpm")
  67     ("\\(:-*[/\\\"]\\)[^/]\\W" 1 "FaceIronic.xpm")
  68     ("\\([8|]-*[|Oo%]\\)\\W" 1 "FaceKOed.xpm")
  69     ("\\([:|]-*#+\\)\\W" 1 "FaceNyah.xpm")
  70     ("\\(:-*[({]+\\)\\W" 1 "FaceSad.xpm")
  71     ("\\(=[({]+\\)\\W" 1 "FaceSad.xpm")
  72     ("\\(:-*[Oo\*]\\)\\W" 1 "FaceStartled.xpm")
  73     ("\\(:-*|\\)\\W" 1 "FaceStraight.xpm")
  74     ("\\(:-*p\\)\\W" 1 "FaceTalking.xpm")
  75     ("\\(:-*d\\)\\W" 1 "FaceTasty.xpm")
  76     ("\\(;-*[>)}»]+\\)\\W" 1 "FaceWinking.xpm")
  77     ("\\(:-*[Vvµ]\\)\\W" 1 "FaceWry.xpm")
  78     ("\\([:|]-*P\\)\\W" 1 "FaceYukky.xpm"))
  79   "*Normal and deformed faces for smilies."
  80   :type '(repeat (list regexp
  81                        (integer :tag "Match")
  82                        (string :tag "Image")))
  83   :group 'smiley)
  84
  85 (defcustom smiley-nosey-regexp-alist
  86   '(("\\(:-+[<«]+\\)\\W" 1 "FaceAngry.xpm")
  87     ("\\(:-+\\]+\\)\\W" 1 "FaceGoofy.xpm")
  88     ("\\(:-+D\\)\\W" 1 "FaceGrinning.xpm")
  89     ("\\(:-+[}»]+\\)\\W" 1 "FaceHappy.xpm")
  90     ("\\(:-*)+\\)\\W" 1 "FaceHappy.xpm")
  91     ("\\(=[)>]+\\)\\W" 1 "FaceHappy.xpm")
  92     ("\\(:-+[/\\\"]+\\)\\W" 1 "FaceIronic.xpm")
  93     ("\\([8|]-+[|Oo%]\\)\\W" 1 "FaceKOed.xpm")
  94     ("\\([:|]-+#+\\)\\W" 1 "FaceNyah.xpm")
  95     ("\\(:-+[({]+\\)\\W" 1 "FaceSad.xpm")
  96     ("\\(=[({]+\\)\\W" 1 "FaceSad.xpm")
  97     ("\\(:-+[Oo\*]\\)\\W" 1 "FaceStartled.xpm")
  98     ("\\(:-+|\\)\\W" 1 "FaceStraight.xpm")
  99     ("\\(:-+p\\)\\W" 1 "FaceTalking.xpm")
 100     ("\\(:-+d\\)\\W" 1 "FaceTasty.xpm")
 101     ("\\(;-+[>)}»]+\\)\\W" 1 "FaceWinking.xpm")
 102     ("\\(:-+[Vvµ]\\)\\W" 1 "FaceWry.xpm")
 103     ("\\(][:8B]-[)>]\\)\\W" 1 "FaceDevilish.xpm")
 104     ("\\([:|]-+P\\)\\W" 1 "FaceYukky.xpm"))
 105   "*Smileys with noses.  These get less false matches."
 106   :type '(repeat (list regexp
 107                        (integer :tag "Match")
 108                        (string :tag "Image")))
 109   :group 'smiley)
 110
 111 (defcustom smiley-regexp-alist smiley-deformed-regexp-alist
 112   "*A list of regexps to map smilies to real images.
 113 Defaults to the contents of `smiley-deformed-regexp-alist'.
 114 An alternative is `smiley-nosey-regexp-alist' that matches less
 115 aggressively.
 116 If this is a symbol, take its value."
 117   :type '(radio (variable-item smiley-deformed-regexp-alist)
 118                 (variable-item smiley-nosey-regexp-alist)
 119                 symbol
 120                 (repeat (list regexp
 121                               (integer :tag "Match")
 122                               (string :tag "Image"))))
 123   :group 'smiley)
 124
 125 (defcustom smiley-flesh-color "yellow"
 126   "*Flesh color."
 127   :type 'string
 128   :group 'smiley)
 129
 130 (defcustom smiley-features-color "black"
 131   "*Features color."
 132   :type 'string
 133   :group 'smiley)
 134
 135 (defcustom smiley-tongue-color "red"
 136   "*Tongue color."
 137   :type 'string
 138   :group 'smiley)
 139
 140 (defcustom smiley-circle-color "black"
 141   "*Circle color."
 142   :type 'string
 143   :group 'smiley)
 144
 145 (defcustom smiley-mouse-face 'highlight
 146   "*Face used for mouse highlighting in the smiley buffer.
 147
 148 Smiley buttons will be displayed in this face when the cursor is
 149 above them."
 150   :type 'face
 151   :group 'smiley)
 152
 153 (defvar smiley-glyph-cache nil)
 154 (defvar smiley-running-xemacs (string-match "XEmacs" emacs-version))
 155
 156 (defvar smiley-map (make-sparse-keymap "smiley-keys")
 157  "Keymap to toggle smiley states.")
 158
 159 (define-key smiley-map [(button2)] 'smiley-toggle-extent)
 160 (define-key smiley-map [(button3)] 'smiley-popup-menu)
 161
 162 (defun smiley-popup-menu (e)
 163   (interactive "e")
 164   (popup-menu
 165    `("Smilies"
 166      ["Toggle This Smiley" (smiley-toggle-extent ,e) t]
 167      ["Toggle All Smilies" (smiley-toggle-extents ,e) t])))
 168
 169 (defun smiley-create-glyph (smiley pixmap)
 170   (and
 171    smiley-running-xemacs
 172    (or
 173     (cdr-safe (assoc pixmap smiley-glyph-cache))
 174     (let* ((xpm-color-symbols
 175             (and (featurep 'xpm)
 176                  (append `(("flesh" ,smiley-flesh-color)
 177                            ("features" ,smiley-features-color)
 178                            ("tongue" ,smiley-tongue-color))
 179                          xpm-color-symbols)))
 180            (glyph (make-glyph
 181                    (list
 182                     (cons 'x (expand-file-name pixmap smiley-data-directory))
 183                     (cons 'tty smiley)))))
 184       (setq smiley-glyph-cache (cons (cons pixmap glyph) smiley-glyph-cache))
 185       (set-glyph-face glyph 'default)
 186       glyph))))
 187
 188 ;;;###autoload
 189 (defun smiley-region (beg end)
 190   "Smilify the region between point and mark."
 191   (interactive "r")
 192   (smiley-buffer (current-buffer) beg end))
 193
 194 (defun smiley-toggle-extent (event)
 195   "Toggle smiley at given point"
 196   (interactive "e")
 197   (let* ((ant (event-glyph-extent event))
 198          (pt (event-closest-point event))
 199          ext)
 200     (if (annotationp ant)
 201         (when (extentp (setq ext (extent-property ant 'smiley-extent)))
 202           (set-extent-property ext 'invisible nil)
 203           (hide-annotation ant))
 204       (when pt
 205         (while (setq ext (extent-at pt (event-buffer event) nil ext 'at))
 206           (when (annotationp (setq ant
 207                                    (extent-property ext 'smiley-annotation)))
 208             (reveal-annotation ant)
 209             (set-extent-property ext 'invisible t)))))))
 210
 211 (defun smiley-toggle-extents (e)
 212   (interactive "e")
 213   (map-extents
 214    '(lambda (e void)
 215       (let (ant)
 216         (if (annotationp (setq ant (extent-property e 'smiley-annotation)))
 217             (progn
 218               (if (eq (extent-property e 'invisible) nil)
 219                   (progn
 220                     (reveal-annotation ant)
 221                     (set-extent-property e 'invisible t)
 222                     )
 223                 (hide-annotation ant)
 224                 (set-extent-property e 'invisible nil))))
 225         nil))
 226    (event-buffer e)))
 227
 228 ;;;###autoload
 229 (defun smiley-buffer (&optional buffer st nd)
 230   (interactive)
 231   (when (featurep 'x)
 232     (save-excursion
 233       (when buffer
 234         (set-buffer buffer))
 235       (let ((buffer-read-only nil)
 236             (alist (if (symbolp smiley-regexp-alist)
 237                        (symbol-value smiley-regexp-alist)
 238                      smiley-regexp-alist))
 239             (case-fold-search nil)
 240             entry regexp beg group file)
 241         (map-extents
 242          '(lambda (e void)
 243             (when (or (extent-property e 'smiley-extent)
 244                       (extent-property e 'smiley-annotation))
 245               (delete-extent e)))
 246          buffer st nd)
 247         (goto-char (or st (point-min)))
 248         (setq beg (point))
 249         ;; loop through alist
 250         (while (setq entry (pop alist))
 251           (setq regexp (car entry)
 252                 group (cadr entry)
 253                 file (caddr entry))
 254           (goto-char beg)
 255           (while (re-search-forward regexp nd t)
 256             (let* ((start (match-beginning group))
 257                    (end (match-end group))
 258                    (glyph (smiley-create-glyph (buffer-substring start end)
 259                                                file)))
 260               (when glyph
 261                 (mapcar 'delete-annotation (annotations-at end))
 262                 (let ((ext (make-extent start end))
 263                       (ant (make-annotation glyph end 'text)))
 264                   ;; set text extent params
 265                   (set-extent-property ext 'end-open t)
 266                   (set-extent-property ext 'start-open t)
 267                   (set-extent-property ext 'invisible t)
 268                   (set-extent-property ext 'keymap smiley-map)
 269                   (set-extent-property ext 'mouse-face smiley-mouse-face)
 270                   (set-extent-property ext 'intangible t)
 271                   ;; set annotation params
 272                   (set-extent-property ant 'mouse-face smiley-mouse-face)
 273                   (set-extent-property ant 'keymap smiley-map)
 274                   ;; remember each other
 275                   (set-extent-property ant 'smiley-extent ext)
 276                   (set-extent-property ext 'smiley-annotation ant)
 277                   ;; Help
 278                   (set-extent-property ext 'help-echo
 279                                        "button2 toggles smiley, button3 pops up menu")
 280                   (set-extent-property ant 'help-echo
 281                                        "button2 toggles smiley, button3 pops up menu")
 282                   (set-extent-property ext 'balloon-help
 283                                        "Mouse button2 - toggle smiley
 284 Mouse button3 - menu")
 285                   (set-extent-property ant 'balloon-help
 286                                        "Mouse button2 - toggle smiley
 287 Mouse button3 - menu"))
 288                 (when (smiley-end-paren-p start end)
 289                   (make-annotation ")" end 'text))
 290                 (goto-char end)))))))))
 291
 292 (defun smiley-end-paren-p (start end)
 293   "Try to guess whether the current smiley is an end-paren smiley."
 294   (save-excursion
 295     (goto-char start)
 296     (when (and (re-search-backward "[()]" nil t)
 297                (= (following-char) ?\()
 298                (goto-char end)
 299                (or (not (re-search-forward "[()]" nil t))
 300                    (= (char-after (1- (point))) ?\()))
 301       t)))
 302
 303 (defvar gnus-article-buffer)
 304 ;;;###autoload
 305 (defun gnus-smiley-display ()
 306   "Display \"smileys\" as small graphical icons."
 307   (interactive)
 308   (save-excursion
 309     (set-buffer gnus-article-buffer)
 310     (goto-char (point-min))
 311     ;; We skip the headers.
 312     (unless (search-forward "\n\n" nil t)
 313       (goto-char (point-max)))
 314     (smiley-buffer (current-buffer) (point))))
 315
 316 (provide 'smiley)
 317
 318 ;;; smiley.el ends here