[bpt/emacs.git] / lisp / gnus / earcon.el

;;; earcon.el --- Sound effects for messages

;; Copyright (C) 1996, 2000, 2001, 2002, 2003, 2004,
;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.

;; Author: Steven L. Baur <steve@miranova.com>

;; 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 <http://www.gnu.org/licenses/>.

;;; Commentary:
;; This file provides access to sound effects in Gnus.

;;; Code:

(eval-when-compile (require 'cl))
(require 'gnus)
(require 'gnus-audio)
(require 'gnus-art)

(defgroup earcon nil
  "Turn ** sounds ** into noise."
  :group 'gnus-visual)

(defcustom earcon-prefix "**"
  "*String denoting the start of an earcon."
  :type 'string
  :group 'earcon)

(defcustom earcon-suffix "**"
  "String denoting the end of an earcon."
  :type 'string
  :group 'earcon)

(defcustom earcon-regexp-alist
  '(("boring" 1 "Boring.au")
    ("evil[ \t]+laugh" 1 "Evil_Laugh.au")
    ("gag\\|puke" 1 "Puke.au")
    ("snicker" 1 "Snicker.au")
    ("meow" 1 "catmeow.wav")
    ("sob\\|boohoo" 1 "cry.wav")
    ("drum[ \t]*roll" 1 "drumroll.au")
    ("blast" 1 "explosion.au")
    ("flush\\|plonk!*" 1 "flush.au")
    ("kiss" 1 "kiss.wav")
    ("tee[ \t]*hee" 1 "laugh.au")
    ("shoot" 1 "shotgun.wav")
    ("yawn" 1 "snore.wav")
    ("cackle" 1 "witch.au")
    ("yell\\|roar" 1 "yell2.au")
    ("whoop-de-doo" 1 "whistle.au"))
  "*A list of regexps to map earcons to real sounds."
  :type '(repeat (list regexp
		       (integer :tag "Match")
		       (string :tag "Sound")))
  :group 'earcon)
(defvar earcon-button-marker-list nil)
(make-variable-buffer-local 'earcon-button-marker-list)

;;; FIXME!! clone of code from gnus-vis.el FIXME!!
(defun earcon-article-push-button (event)
  "Check text under the mouse pointer for a callback function.
If the text under the mouse pointer has a `earcon-callback' property,
call it with the value of the `earcon-data' text property."
  (interactive "e")
  (set-buffer (window-buffer (posn-window (event-start event))))
  (let* ((pos (posn-point (event-start event)))
	 (data (get-text-property pos 'earcon-data))
	 (fun (get-text-property pos 'earcon-callback)))
    (if fun (funcall fun data))))

(defun earcon-article-press-button ()
  "Check text at point for a callback function.
If the text at point has a `earcon-callback' property,
call it with the value of the `earcon-data' text property."
  (interactive)
  (let* ((data (get-text-property (point) 'earcon-data))
	 (fun (get-text-property (point) 'earcon-callback)))
    (if fun (funcall fun data))))

(defun earcon-article-prev-button (n)
  "Move point to N buttons backward.
If N is negative, move forward instead."
  (interactive "p")
  (earcon-article-next-button (- n)))

(defun earcon-article-next-button (n)
  "Move point to N buttons forward.
If N is negative, move backward instead."
  (interactive "p")
  (let ((function (if (< n 0) 'previous-single-property-change
		    'next-single-property-change))
	(inhibit-point-motion-hooks t)
	(backward (< n 0))
	(limit (if (< n 0) (point-min) (point-max))))
    (setq n (abs n))
    (while (and (not (= limit (point)))
		(> n 0))
      ;; Skip past the current button.
      (when (get-text-property (point) 'earcon-callback)
	(goto-char (funcall function (point) 'earcon-callback nil limit)))
      ;; Go to the next (or previous) button.
      (gnus-goto-char (funcall function (point) 'earcon-callback nil limit))
      ;; Put point at the start of the button.
      (when (and backward (not (get-text-property (point) 'earcon-callback)))
	(goto-char (funcall function (point) 'earcon-callback nil limit)))
      ;; Skip past intangible buttons.
      (when (get-text-property (point) 'intangible)
	(incf n))
      (decf n))
    (unless (zerop n)
      (gnus-message 5 "No more buttons"))
    n))

(defun earcon-article-add-button (from to fun &optional data)
  "Create a button between FROM and TO with callback FUN and data DATA."
  (and (boundp gnus-article-button-face)
       gnus-article-button-face
       (gnus-overlay-put (gnus-make-overlay from to)
			 'face gnus-article-button-face))
  (gnus-add-text-properties
   from to
   (nconc (and gnus-article-mouse-face
	       (list gnus-mouse-face-prop gnus-article-mouse-face))
	  (list 'gnus-callback fun)
	  (and data (list 'gnus-data data)))))

(defun earcon-button-entry ()
  ;; Return the first entry in `gnus-button-alist' matching this place.
  (let ((alist earcon-regexp-alist)
	(case-fold-search t)
	(entry nil))
    (while alist
      (setq entry (pop alist))
      (if (looking-at (car entry))
	  (setq alist nil)
	(setq entry nil)))
    entry))

(defun earcon-button-push (marker)
  ;; Push button starting at MARKER.
  (save-excursion
    (set-buffer gnus-article-buffer)
    (goto-char marker)
    (let* ((entry (earcon-button-entry))
	   (inhibit-point-motion-hooks t)
	   (fun 'gnus-audio-play)
	   (args (list (nth 2 entry))))
      (cond
       ((fboundp fun)
	(apply fun args))
       ((and (boundp fun)
	     (fboundp (symbol-value fun)))
	(apply (symbol-value fun) args))
       (t
	(gnus-message 1 "You must define `%S' to use this button"
		      (cons fun args)))))))

;;; FIXME!! clone of code from gnus-vis.el FIXME!!

;;;###interactive
(defun earcon-region (beg end)
  "Play Sounds in the region between point and mark."
  (interactive "r")
  (earcon-buffer (current-buffer) beg end))

;;;###interactive
(defun earcon-buffer (&optional buffer st nd)
  (interactive)
  (save-excursion
    ;; clear old markers.
    (if (boundp 'earcon-button-marker-list)
	(while earcon-button-marker-list
	  (set-marker (pop earcon-button-marker-list) nil))
      (setq earcon-button-marker-list nil))
    (and buffer (set-buffer buffer))
    (let ((buffer-read-only nil)
	  (inhibit-point-motion-hooks t)
	  (case-fold-search t)
	  (alist earcon-regexp-alist)
	  beg entry regexp)
      (goto-char (point-min))
      (setq beg (point))
      (while (setq entry (pop alist))
	(setq regexp (concat (regexp-quote earcon-prefix)
			     ".*\\("
			     (car entry)
			     "\\).*"
			     (regexp-quote earcon-suffix)))
	(goto-char beg)
	(while (re-search-forward regexp nil t)
	  (let* ((start (and entry (match-beginning 1)))
		 (end (and entry (match-end 1)))
		 (from (match-beginning 1)))
	    (earcon-article-add-button
	     start end 'earcon-button-push
	     (car (push (set-marker (make-marker) from)
			earcon-button-marker-list)))
	    (gnus-audio-play (caddr entry))))))))

;;;###autoload
(defun gnus-earcon-display ()
  "Play sounds in message buffers."
  (interactive)
  (save-excursion
    (set-buffer gnus-article-buffer)
    (goto-char (point-min))
    ;; Skip headers
    (unless (search-forward "\n\n" nil t)
      (goto-char (point-max)))
    (sit-for 0)
    (earcon-buffer (current-buffer) (point))))

;;;***

(provide 'earcon)

(run-hooks 'earcon-load-hook)

;; arch-tag: 844dfeea-980c-4ed0-907f-a30bf139691c
;;; earcon.el ends here
Commit	Line	Data
23f87bed	1	;;; earcon.el --- Sound effects for messages
16409b0b	2
e84b4b86	3	;; Copyright (C) 1996, 2000, 2001, 2002, 2003, 2004,
114f9c96	4	;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
eec82323 LMI	5
eec82323 LMI	6	;; Author: Steven L. Baur <steve@miranova.com>
16409b0b GM	7
	8	;; This file is part of GNU Emacs.
	9
5e809f55	10	;; GNU Emacs is free software: you can redistribute it and/or modify
eec82323	11	;; it under the terms of the GNU General Public License as published by
5e809f55 GM	12	;; the Free Software Foundation, either version 3 of the License, or
5e809f55 GM	13	;; (at your option) any later version.
eec82323 LMI	14
	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.
	19
	20	;; You should have received a copy of the GNU General Public License
5e809f55	21	;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
eec82323 LMI	22
	23	;;; Commentary:
	24	;; This file provides access to sound effects in Gnus.
	25
	26	;;; Code:
	27
7fb884d9	28	(eval-when-compile (require 'cl))
eec82323 LMI	29	(require 'gnus)
	30	(require 'gnus-audio)
	31	(require 'gnus-art)
eec82323 LMI	32
	33	(defgroup earcon nil
	34	"Turn sounds into noise."
	35	:group 'gnus-visual)
	36
eec82323	37	(defcustom earcon-prefix "**"
44a6ed57	38	"*String denoting the start of an earcon."
eec82323 LMI	39	:type 'string
	40	:group 'earcon)
	41
	42	(defcustom earcon-suffix "**"
	43	"String denoting the end of an earcon."
	44	:type 'string
	45	:group 'earcon)
	46
	47	(defcustom earcon-regexp-alist
	48	'(("boring" 1 "Boring.au")
	49	("evil[ \t]+laugh" 1 "Evil_Laugh.au")
	50	("gag\\\|puke" 1 "Puke.au")
	51	("snicker" 1 "Snicker.au")
23f87bed	52	("meow" 1 "catmeow.wav")
eec82323 LMI	53	("sob\\\|boohoo" 1 "cry.wav")
	54	("drum[ \t]*roll" 1 "drumroll.au")
	55	("blast" 1 "explosion.au")
	56	("flush\\\|plonk!*" 1 "flush.au")
	57	("kiss" 1 "kiss.wav")
	58	("tee[ \t]*hee" 1 "laugh.au")
	59	("shoot" 1 "shotgun.wav")
	60	("yawn" 1 "snore.wav")
	61	("cackle" 1 "witch.au")
	62	("yell\\\|roar" 1 "yell2.au")
	63	("whoop-de-doo" 1 "whistle.au"))
44a6ed57	64	"*A list of regexps to map earcons to real sounds."
eec82323 LMI	65	:type '(repeat (list regexp
	66	(integer :tag "Match")
	67	(string :tag "Sound")))
	68	:group 'earcon)
eec82323 LMI	69	(defvar earcon-button-marker-list nil)
	70	(make-variable-buffer-local 'earcon-button-marker-list)
	71
eec82323 LMI	72	;;; FIXME!! clone of code from gnus-vis.el FIXME!!
	73	(defun earcon-article-push-button (event)
	74	"Check text under the mouse pointer for a callback function.
	75	If the text under the mouse pointer has a `earcon-callback' property,
	76	call it with the value of the `earcon-data' text property."
	77	(interactive "e")
	78	(set-buffer (window-buffer (posn-window (event-start event))))
	79	(let* ((pos (posn-point (event-start event)))
23f87bed	80	(data (get-text-property pos 'earcon-data))
eec82323 LMI	81	(fun (get-text-property pos 'earcon-callback)))
	82	(if fun (funcall fun data))))
	83
	84	(defun earcon-article-press-button ()
	85	"Check text at point for a callback function.
	86	If the text at point has a `earcon-callback' property,
	87	call it with the value of the `earcon-data' text property."
	88	(interactive)
	89	(let* ((data (get-text-property (point) 'earcon-data))
	90	(fun (get-text-property (point) 'earcon-callback)))
	91	(if fun (funcall fun data))))
	92
	93	(defun earcon-article-prev-button (n)
	94	"Move point to N buttons backward.
	95	If N is negative, move forward instead."
	96	(interactive "p")
	97	(earcon-article-next-button (- n)))
	98
	99	(defun earcon-article-next-button (n)
	100	"Move point to N buttons forward.
	101	If N is negative, move backward instead."
	102	(interactive "p")
	103	(let ((function (if (< n 0) 'previous-single-property-change
	104	'next-single-property-change))
	105	(inhibit-point-motion-hooks t)
	106	(backward (< n 0))
	107	(limit (if (< n 0) (point-min) (point-max))))
	108	(setq n (abs n))
	109	(while (and (not (= limit (point)))
	110	(> n 0))
	111	;; Skip past the current button.
	112	(when (get-text-property (point) 'earcon-callback)
	113	(goto-char (funcall function (point) 'earcon-callback nil limit)))
	114	;; Go to the next (or previous) button.
	115	(gnus-goto-char (funcall function (point) 'earcon-callback nil limit))
	116	;; Put point at the start of the button.
	117	(when (and backward (not (get-text-property (point) 'earcon-callback)))
	118	(goto-char (funcall function (point) 'earcon-callback nil limit)))
	119	;; Skip past intangible buttons.
	120	(when (get-text-property (point) 'intangible)
	121	(incf n))
	122	(decf n))
	123	(unless (zerop n)
	124	(gnus-message 5 "No more buttons"))
	125	n))
	126
	127	(defun earcon-article-add-button (from to fun &optional data)
	128	"Create a button between FROM and TO with callback FUN and data DATA."
	129	(and (boundp gnus-article-button-face)
	130	gnus-article-button-face
	131	(gnus-overlay-put (gnus-make-overlay from to)
	132	'face gnus-article-button-face))
	133	(gnus-add-text-properties
	134	from to
	135	(nconc (and gnus-article-mouse-face
	136	(list gnus-mouse-face-prop gnus-article-mouse-face))
	137	(list 'gnus-callback fun)
	138	(and data (list 'gnus-data data)))))
	139
	140	(defun earcon-button-entry ()
	141	;; Return the first entry in `gnus-button-alist' matching this place.
	142	(let ((alist earcon-regexp-alist)
	143	(case-fold-search t)
	144	(entry nil))
145	(while alist
146	(setq entry (pop alist))
147	(if (looking-at (car entry))
148	(setq alist nil)
149	(setq entry nil)))
150	entry))
151
eec82323 LMI	152	(defun earcon-button-push (marker)
	153	;; Push button starting at MARKER.
	154	(save-excursion
	155	(set-buffer gnus-article-buffer)
	156	(goto-char marker)
	157	(let* ((entry (earcon-button-entry))
	158	(inhibit-point-motion-hooks t)
	159	(fun 'gnus-audio-play)
	160	(args (list (nth 2 entry))))
	161	(cond
	162	((fboundp fun)
	163	(apply fun args))
	164	((and (boundp fun)
	165	(fboundp (symbol-value fun)))
	166	(apply (symbol-value fun) args))
	167	(t
	168	(gnus-message 1 "You must define `%S' to use this button"
	169	(cons fun args)))))))
	170
	171	;;; FIXME!! clone of code from gnus-vis.el FIXME!!
	172
	173	;;;###interactive
	174	(defun earcon-region (beg end)
	175	"Play Sounds in the region between point and mark."
	176	(interactive "r")
	177	(earcon-buffer (current-buffer) beg end))
	178
	179	;;;###interactive
	180	(defun earcon-buffer (&optional buffer st nd)
	181	(interactive)
	182	(save-excursion
	183	;; clear old markers.
	184	(if (boundp 'earcon-button-marker-list)
	185	(while earcon-button-marker-list
	186	(set-marker (pop earcon-button-marker-list) nil))
	187	(setq earcon-button-marker-list nil))
	188	(and buffer (set-buffer buffer))
	189	(let ((buffer-read-only nil)
	190	(inhibit-point-motion-hooks t)
	191	(case-fold-search t)
	192	(alist earcon-regexp-alist)
	193	beg entry regexp)
	194	(goto-char (point-min))
	195	(setq beg (point))
	196	(while (setq entry (pop alist))
	197	(setq regexp (concat (regexp-quote earcon-prefix)
	198	".*\\("
	199	(car entry)
	200	"\\).*"
	201	(regexp-quote earcon-suffix)))
	202	(goto-char beg)
	203	(while (re-search-forward regexp nil t)
	204	(let* ((start (and entry (match-beginning 1)))
	205	(end (and entry (match-end 1)))
	206	(from (match-beginning 1)))
	207	(earcon-article-add-button
	208	start end 'earcon-button-push
	209	(car (push (set-marker (make-marker) from)
	210	earcon-button-marker-list)))
	211	(gnus-audio-play (caddr entry))))))))
	212
	213	;;;###autoload
	214	(defun gnus-earcon-display ()
	215	"Play sounds in message buffers."
216	(interactive)
217	(save-excursion
218	(set-buffer gnus-article-buffer)
219	(goto-char (point-min))
220	;; Skip headers
221	(unless (search-forward "\n\n" nil t)
222	(goto-char (point-max)))
223	(sit-for 0)
224	(earcon-buffer (current-buffer) (point))))
225
226	;;;***
227
228	(provide 'earcon)
229
230	(run-hooks 'earcon-load-hook)
231
cbee283d	232	;; arch-tag: 844dfeea-980c-4ed0-907f-a30bf139691c
eec82323	233	;;; earcon.el ends here