265 lines
8.6 KiB
EmacsLisp
265 lines
8.6 KiB
EmacsLisp
;;; smiley.el --- displaying smiley faces -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (C) 2000-2024 Free Software Foundation, Inc.
|
|
|
|
;; Author: Dave Love <fx@gnu.org>
|
|
;; Keywords: news mail multimedia
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; A re-written, simplified version of Wes Hardaker's XEmacs smiley.el
|
|
;; which might be merged back to smiley.el if we get an assignment for
|
|
;; that. We don't have assignments for the images smiley.el uses, but
|
|
;; I'm not sure we need that degree of rococoness and defaults like a
|
|
;; yellow background. Also, using PBM means we can display the images
|
|
;; more generally. -- fx
|
|
;; `smiley.el' was replaced by `smiley-ems.el' on 2002-01-26 (after fx'
|
|
;; comment).
|
|
|
|
;; Test smileys:
|
|
;; smile ^:-) ^:)
|
|
;; blink ;-) ;)
|
|
;; forced :-]
|
|
;; braindamaged 8-)
|
|
;; indifferent :-|
|
|
;; wry :-/ :-\
|
|
;; sad :-(
|
|
;; frown :-{
|
|
;; evil >:-)
|
|
;; cry ;-(
|
|
;; dead X-)
|
|
;; grin :-D
|
|
;; halo O:-)
|
|
|
|
;;; Code:
|
|
|
|
(require 'nnheader)
|
|
(require 'gnus-art)
|
|
|
|
(defgroup smiley nil
|
|
"Turn :-)'s into real images."
|
|
:group 'gnus-visual)
|
|
|
|
(defvar smiley-data-directory)
|
|
|
|
;; In batch mode, attributes can be unspecified.
|
|
(defcustom smiley-style (if (ignore-errors
|
|
(>= (face-attribute 'default :height) 160))
|
|
'medium
|
|
'low-color)
|
|
"Smiley style."
|
|
:type '(choice (const :tag "small, 3 colors" low-color) ;; 13x14
|
|
(const :tag "medium, ~10 colors" medium) ;; 16x16
|
|
(const :tag "dull, grayscale" grayscale) ;; 14x14
|
|
(const :tag "emoji, full color" emoji))
|
|
:set (lambda (symbol value)
|
|
(set-default symbol value)
|
|
(setq smiley-data-directory (smiley-directory))
|
|
(smiley-update-cache))
|
|
:initialize #'custom-initialize-default
|
|
:version "23.1") ;; No Gnus
|
|
|
|
;; For compatibility, honor the variable `smiley-data-directory' if the user
|
|
;; has set it.
|
|
|
|
(defun smiley-directory (&optional style)
|
|
"Return a the location of the smiley faces files.
|
|
STYLE specifies which style to use, see `smiley-style'. If STYLE
|
|
is nil, use `smiley-style'."
|
|
(unless style (setq style smiley-style))
|
|
(nnheader-find-etc-directory
|
|
(concat "images/smilies"
|
|
(cond ((eq smiley-style 'low-color) "")
|
|
((eq smiley-style 'medium) "/medium")
|
|
((eq smiley-style 'grayscale) "/grayscale")))))
|
|
|
|
(defcustom smiley-data-directory (smiley-directory)
|
|
"Location of the smiley faces files."
|
|
:set (lambda (symbol value)
|
|
(set-default symbol value)
|
|
(smiley-update-cache))
|
|
:initialize #'custom-initialize-default
|
|
:type 'directory)
|
|
|
|
(defcustom smiley-emoji-regexp-alist
|
|
'(("\\(;-)\\)\\W" 1 "😉")
|
|
("[^;]\\(;)\\)\\W" 1 "😉")
|
|
("\\(:-]\\)\\W" 1 "😬")
|
|
("\\(8-)\\)\\W" 1 "🥴")
|
|
("\\(:-|\\)\\W" 1 "😐")
|
|
("\\(:-[/\\]\\)\\W" 1 "😕")
|
|
("\\(:-(\\)\\W" 1 "😠")
|
|
("\\(X-)\\)\\W" 1 "😵") ; 💀
|
|
("\\(:-{\\)\\W" 1 "😦")
|
|
("\\(>:-)\\)\\W" 1 "😈")
|
|
("\\(;-(\\)\\W" 1 "😢")
|
|
("\\(:-D\\)\\W" 1 "😀")
|
|
("\\(O:-)\\)\\W" 1 "😇")
|
|
;; "smile" must be come after "evil"
|
|
("\\(\\^?:-?)\\)\\W" 1 "🙂"))
|
|
"A list of regexps to map smilies to emoji.
|
|
The elements are (REGEXP MATCH EMOJI), where MATCH is the submatch in
|
|
regexp to replace with EMOJI."
|
|
:version "28.1"
|
|
:type '(repeat (list regexp
|
|
(integer :tag "Regexp match number")
|
|
(string :tag "Emoji")))
|
|
:set (lambda (symbol value)
|
|
(set-default symbol value)
|
|
(smiley-update-cache))
|
|
:initialize #'custom-initialize-default)
|
|
|
|
;; The XEmacs version has a baroque, if not rococo, set of these.
|
|
(defcustom smiley-regexp-alist
|
|
'(("\\(;-)\\)\\W" 1 "blink")
|
|
("[^;]\\(;)\\)\\W" 1 "blink")
|
|
("\\(:-]\\)\\W" 1 "forced")
|
|
("\\(8-)\\)\\W" 1 "braindamaged")
|
|
("\\(:-|\\)\\W" 1 "indifferent")
|
|
("\\(:-[/\\]\\)\\W" 1 "wry")
|
|
("\\(:-(\\)\\W" 1 "sad")
|
|
("\\(X-)\\)\\W" 1 "dead")
|
|
("\\(:-{\\)\\W" 1 "frown")
|
|
("\\(>:-)\\)\\W" 1 "evil")
|
|
("\\(;-(\\)\\W" 1 "cry")
|
|
("\\(:-D\\)\\W" 1 "grin")
|
|
;; "smile" must be come after "evil"
|
|
("\\(\\^?:-?)\\)\\W" 1 "smile"))
|
|
"A list of regexps to map smilies to images.
|
|
The elements are (REGEXP MATCH IMAGE), where MATCH is the submatch in
|
|
regexp to replace with IMAGE. IMAGE is the name of an image file in
|
|
`smiley-data-directory'."
|
|
:version "24.1"
|
|
:type '(repeat (list regexp
|
|
(integer :tag "Regexp match number")
|
|
(string :tag "Image name")))
|
|
:set (lambda (symbol value)
|
|
(set-default symbol value)
|
|
(smiley-update-cache))
|
|
:initialize #'custom-initialize-default)
|
|
|
|
(defcustom gnus-smiley-file-types
|
|
(let ((types (list "pbm")))
|
|
(when (gnus-image-type-available-p 'xpm)
|
|
(push "xpm" types))
|
|
(when (gnus-image-type-available-p 'gif)
|
|
(push "gif" types))
|
|
types)
|
|
"List of suffixes on smiley file names to try."
|
|
:version "24.1"
|
|
:type '(repeat string))
|
|
|
|
(defvar smiley-cached-regexp-alist nil)
|
|
|
|
(defun smiley-update-cache ()
|
|
(setq smiley-cached-regexp-alist nil)
|
|
(if (eq smiley-style 'emoji)
|
|
(setq smiley-cached-regexp-alist smiley-emoji-regexp-alist)
|
|
(dolist (elt (if (symbolp smiley-regexp-alist)
|
|
(symbol-value smiley-regexp-alist)
|
|
smiley-regexp-alist))
|
|
(let ((types gnus-smiley-file-types)
|
|
file type)
|
|
(while (and (not file)
|
|
(setq type (pop types)))
|
|
(unless (file-exists-p
|
|
(setq file (expand-file-name (concat (nth 2 elt) "." type)
|
|
smiley-data-directory)))
|
|
(setq file nil)))
|
|
(when type
|
|
(let ((image (gnus-create-image file (intern type) nil
|
|
:ascent 'center)))
|
|
(when image
|
|
(push (list (car elt) (cadr elt) image)
|
|
smiley-cached-regexp-alist))))))))
|
|
|
|
;; Not implemented:
|
|
;; (defvar smiley-mouse-map
|
|
;; (let ((map (make-sparse-keymap)))
|
|
;; (define-key map [down-mouse-2] 'ignore) ; override widget
|
|
;; (define-key map [mouse-2]
|
|
;; 'smiley-mouse-toggle-buffer)
|
|
;; map))
|
|
|
|
;;;###autoload
|
|
(defun smiley-region (start end)
|
|
"Replace in the region `smiley-regexp-alist' matches with corresponding images.
|
|
A list of images is returned."
|
|
(interactive "r")
|
|
(when (display-graphic-p)
|
|
(unless smiley-cached-regexp-alist
|
|
(smiley-update-cache))
|
|
(save-excursion
|
|
(let ((beg (or start (point-min)))
|
|
group image images string)
|
|
(dolist (entry smiley-cached-regexp-alist)
|
|
(setq group (nth 1 entry)
|
|
image (nth 2 entry))
|
|
(goto-char beg)
|
|
(while (re-search-forward (car entry) end t)
|
|
(setq string (match-string group))
|
|
(goto-char (match-end group))
|
|
(delete-region (match-beginning group) (match-end group))
|
|
(when image
|
|
(push image images)
|
|
(gnus-add-wash-type 'smiley)
|
|
(if (symbolp image)
|
|
(progn
|
|
(gnus-add-image 'smiley image)
|
|
(gnus-put-image image string 'smiley))
|
|
;; This is a string, but mark the property for
|
|
;; deletion if the washing method is switched off.
|
|
(insert (propertize string
|
|
'display image
|
|
'gnus-image-category 'smiley))))))
|
|
images))))
|
|
|
|
;;;###autoload
|
|
(defun smiley-buffer (&optional buffer)
|
|
"Run `smiley-region' at the BUFFER, specified in the argument or
|
|
interactively. If there's no argument, do it at the current buffer."
|
|
(interactive "bBuffer to run smiley-region: ")
|
|
(save-excursion
|
|
(if buffer
|
|
(set-buffer (get-buffer buffer)))
|
|
(smiley-region (point-min) (point-max))))
|
|
|
|
(defun smiley-toggle-buffer (&optional arg)
|
|
"Toggle displaying smiley faces in article buffer.
|
|
With arg, turn displaying on if and only if arg is positive."
|
|
(interactive "P" gnus-article-mode gnus-summary-mode)
|
|
(gnus-with-article-buffer
|
|
(if (if (numberp arg)
|
|
(> arg 0)
|
|
(not (memq 'smiley gnus-article-wash-types)))
|
|
(smiley-region (point-min) (point-max))
|
|
(gnus-delete-images 'smiley))))
|
|
|
|
(defun smiley-mouse-toggle-buffer (event)
|
|
"Toggle displaying smiley faces.
|
|
With arg, turn displaying on if and only if arg is positive."
|
|
(interactive "e")
|
|
(save-excursion
|
|
(save-window-excursion
|
|
(mouse-set-point event)
|
|
(smiley-toggle-buffer))))
|
|
|
|
(provide 'smiley)
|
|
|
|
;;; smiley.el ends here
|