diff src/sound.c @ 793:e38acbeb1cae

[xemacs-hg @ 2002-03-29 04:46:17 by ben] lots o' fixes etc/ChangeLog: New file. Separated out all entries for etc/ into their own ChangeLog. Includes entries for the following files: etc/BABYL, etc/BETA, etc/CHARSETS, etc/DISTRIB, etc/Emacs.ad, etc/FTP, etc/GNUS-NEWS, etc/GOATS, etc/HELLO, etc/INSTALL, etc/MACHINES, etc/MAILINGLISTS, etc/MSDOS, etc/MYTHOLOGY, etc/NEWS, etc/OXYMORONS, etc/PACKAGES, etc/README, etc/TUTORIAL, etc/TUTORIAL.de, etc/TUTORIAL.ja, etc/TUTORIAL.ko, etc/TUTORIAL.se, etc/aliases.ksh, etc/altrasoft-logo.xpm, etc/check_cygwin_setup.sh, etc/custom/example-themes/europe-theme.el, etc/custom/example-themes/ex-custom-file, etc/custom/example-themes/example-theme.el, etc/e/eterm.ti, etc/edt-user.doc, etc/enriched.doc, etc/etags.1, etc/gnuserv.1, etc/gnuserv.README, etc/package-index.LATEST.gpg, etc/package-index.LATEST.pgp, etc/photos/jan.png, etc/recycle.xpm, etc/refcard.tex, etc/sample.Xdefaults, etc/sample.emacs, etc/sgml/CATALOG, etc/sgml/HTML32.dtd, etc/skk/SKK.tut.E, etc/smilies/Face_ase.xbm, etc/smilies/Face_ase2.xbm, etc/smilies/Face_ase3.xbm, etc/smilies/Face_smile.xbm, etc/smilies/Face_weep.xbm, etc/sounds, etc/toolbar, etc/toolbar/workshop-cap-up.xpm, etc/xemacs-ja.1, etc/xemacs.1, etc/yow.lines, etc\BETA, etc\NEWS, etc\README, etc\TUTORIAL, etc\TUTORIAL.de, etc\check_cygwin_setup.sh, etc\sample.init.el, etc\unicode\README, etc\unicode\mule-ucs\*, etc\unicode\other\* unicode/unicode-consortium/8859-16.TXT: New file. mule/english.el: Define this charset now, since a bug was fixed that formerly prevented it. mule/ethio-util.el: Fix compile errors involving Unicode `characters', which should be integers. Makefile.in.in: Always include gui.c, to fix compile error when TTY-only. EmacsFrame.c, abbrev.c, alloc.c, buffer.c, buffer.h, bytecode.c, bytecode.h, callint.c, callproc.c, casetab.c, casetab.h, charset.h, chartab.c, chartab.h, cmds.c, console-msw.c, console-msw.h, console-tty.c, console-x.c, console-x.h, console.c, console.h, data.c, database.c, device-gtk.c, device-msw.c, device-x.c, device.c, device.h, dialog-msw.c, doc.c, doprnt.c, dumper.c, dynarr.c, editfns.c, eldap.c, eldap.h, elhash.c, elhash.h, emacs.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, event-tty.c, event-unixoid.c, events.c, events.h, extents.c, extents.h, faces.c, faces.h, file-coding.c, file-coding.h, fileio.c, filelock.c, fns.c, frame-gtk.c, frame-msw.c, frame-tty.c, frame-x.c, frame.c, frame.h, free-hook.c, general-slots.h, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-widget.c, glyphs-x.c, glyphs.c, glyphs.h, gpmevent.c, gtk-xemacs.c, gui-msw.c, gui-x.c, gui-x.h, gui.c, gui.h, gutter.c, gutter.h, indent.c, input-method-xlib.c, insdel.c, keymap.c, keymap.h, lisp-disunion.h, lisp-union.h, lisp.h, lread.c, lrecord.h, lstream.c, lstream.h, marker.c, menubar-gtk.c, menubar-msw.c, menubar-x.c, menubar.c, minibuf.c, mule-canna.c, mule-ccl.c, mule-charset.c, mule-wnnfns.c, native-gtk-toolbar.c, objects-msw.c, objects-tty.c, objects-x.c, objects.c, objects.h, opaque.c, opaque.h, postgresql.c, postgresql.h, print.c, process-unix.c, process.c, process.h, rangetab.c, rangetab.h, redisplay-gtk.c, redisplay-msw.c, redisplay-output.c, redisplay-tty.c, redisplay-x.c, redisplay.c, scrollbar-gtk.c, scrollbar-msw.c, scrollbar-x.c, scrollbar.c, scrollbar.h, search.c, select-gtk.c, select-x.c, sound.c, specifier.c, specifier.h, strftime.c, symbols.c, symeval.h, syntax.h, text.c, text.h, toolbar-common.c, toolbar-msw.c, toolbar.c, toolbar.h, tooltalk.c, tooltalk.h, ui-gtk.c, ui-gtk.h, undo.c, vm-limit.c, window.c, window.h: Eliminate XSETFOO. Replace all usages with wrap_foo(). Make symbol->name a Lisp_Object, not Lisp_String *. Eliminate nearly all uses of Lisp_String * in favor of Lisp_Object, and correct macros so most of them favor Lisp_Object. Create new error-behavior ERROR_ME_DEBUG_WARN -- output warnings, but at level `debug' (usually ignored). Use it when instantiating specifiers, so problems can be debugged. Move log-warning-minimum-level into C so that we can optimize ERROR_ME_DEBUG_WARN. Fix warning levels consistent with new definitions. Add default_ and parent fields to char table; not yet implemented. New fun Dynarr_verify(); use for further error checking on Dynarrs. Rearrange code at top of lisp.h in conjunction with dynarr changes. Fix eifree(). Use Eistrings in various places (format_event_object(), where_is_to_char(), and callers thereof) to avoid fixed-size strings buffers. New fun write_eistring(). Reindent and fix GPM code to follow standards. Set default MS Windows font to Lucida Console (same size as Courier New but less interline spacing, so more lines fit). Increase default frame size on Windows to 50 lines. (If that's too big for the workspace, the frame will be shrunk as necessary.) Fix problem with text files with no newlines (). (Change `convert-eol' coding system to use `nil' for autodetect, consistent with make-coding-system.) Correct compile warnings in vm-limit.c. Fix handling of reverse-direction charsets to avoid errors when opening (e.g.) mule-ucs/lisp/reldata/uiso8859-6.el. Recode some object printing methods to use write_fmt_string() instead of a fixed buffer and sprintf. Turn on display of png comments as warnings (level `info'), now that they're unobtrusive. Revamped the sound documentation. Fixed bug in redisplay w.r.t. hscroll/truncation/continuation glyphs causing jumping up and down of the lines, since they're bigger than the line size. (It was seen most obviously when there's a horizontal scroll bar, e.g. do C-h a glyph or something like that.) The problem was that the glyph-contrib-p setting on glyphs was ignored even if it was set properly, which it wasn't until now.
author ben
date Fri, 29 Mar 2002 04:49:13 +0000
parents 943eaba38521
children 79c6ff3eef26
line wrap: on
line diff
--- a/src/sound.c	Sat Mar 23 05:08:52 2002 +0000
+++ b/src/sound.c	Fri Mar 29 04:49:13 2002 +0000
@@ -1,6 +1,7 @@
 /* Sound functions.
    Copyright (C) 1992, 1993, 1994 Lucid Inc.
    Copyright (C) 1994, 1995 Free Software Foundation, Inc.
+   Copyright (C) 2002 Ben Wing.
 
 This file is part of XEmacs.
 
@@ -278,7 +279,20 @@
 
 DEFUN ("play-sound", Fplay_sound, 1, 3, 0, /*
 Play a sound of the provided type.
-See the variable `sound-alist'.
+
+SOUND can a symbol, specifying a sound to be looked up in `sound-alist'
+\(generally, either the symbol directly maps to a sound or is an "abstract"
+symbol that maps to another symbol and is used to specify the sound that is
+played when a particular behavior occurs.  `ding' lists the built-in
+abstract sounds and their intended purpose.
+
+SOUND can also be a string, which directly encodes the sound data to be played.
+
+If SOUND is nil, the abstract sound `default' will be used.
+
+VOLUME controls the volume (max is around 150? not sure).
+
+DEVICE is the device to play the sound on (defaults to the selected device).
 
 If the sound cannot be played in any other way, the standard "bell" will sound.
 */
@@ -402,23 +416,61 @@
 
 DEFUN ("ding", Fding, 0, 3, 0, /*
 Beep, or flash the frame.
-Also, unless an argument is given,
-terminate any keyboard macro currently executing.
-When called from lisp, the second argument is what sound to make, and
-the third argument is the device to make it in (defaults to the selected
-device).
+
+\(See `visible-bell'; setting this makes the frame flash instead of
+beeping.)  Also, unless NO-TERMINATE is given, terminate any keyboard macro
+currently executing.  SOUND specifies the sound to make and DEVICE the
+device to make it on (defaults to the selected device).
+
+SOUND is either a string (raw data to be played directly), a symbol, or
+`nil' (equivalent to the symbol `default').  Sound symbols are looked up in
+`sound-alist', and resolve either to strings of data or to other symbols.
+Sound symbols that map directly to data should be considered named sounds;
+sound symbols that map to other sounds should be considered abstract
+sounds, and are used when a particular behavior or state occurs.
+
+Rremember that the sound symbol is the *second* argument to `ding', not the
+first.
+
+The following abstract sounds are used by XEmacs itself:
+
+    alarm		when a package wants to remind the user
+    auto-save-error	when an auto-save does not succeed
+    buffer-bound	when you attempt to move off the end of a buffer
+    command-error	any uncaught error (i.e. any error that the user
+                        sees) except those handled by undefined-click,
+			undefined-key, buffer-bound, or read-only
+    default		used when nothing else is appropriate.
+    isearch-failed      unable to locate search text during incremental search
+    isearch-quit        when you delete chars past the beginning of the search
+                        text in isearch
+    no-completion	during completing-read
+    quit		when C-g is typed
+    read-only           when you try to modify a read-only buffer
+    ready		when a compile or other time-consuming task is done
+    undefined-click	when you use an undefined mouse-click combination
+    undefined-key	when you type a key that is undefined
+    warp		XEmacs has changed the selected-window or frame
+			asynchronously -- e.g. a debugger breakpoint is hit
+			in an asynchronous process filter
+    y-or-n-p		when you type something other than 'y' or 'n'
+    yes-or-no-p  	when you type something other than 'yes' or 'no'
+    
+Other lisp packages may use other beep types, but these are the ones that
+the C kernel of Emacs uses.
+
 */
-       (arg, sound, device))
+       (no_terminate, sound, device))
 {
   static time_t last_bell_time;
   static struct device *last_bell_device;
   time_t now;
   struct device *d = decode_device (device);     
 
-  XSETDEVICE (device, d);
+  device = wrap_device (d);
   now = time (0);
 
-  if (NILP (arg) && !NILP (Vexecuting_macro))
+  if (NILP (no_terminate) && !NILP (Vexecuting_macro))
     /* Stop executing a keyboard macro. */
     invalid_operation ("Keyboard macro terminated by a command ringing the bell", Qunbound);
   
@@ -635,19 +687,10 @@
  - The pitch, duration, and volume options are available everywhere, but
    many X servers ignore the `pitch' option.
 
-The following beep-types are used by emacs itself:
-
-    auto-save-error	when an auto-save does not succeed
-    command-error	when the emacs command loop catches an error
-    undefined-key	when you type a key that is undefined
-    undefined-click	when you use an undefined mouse-click combination
-    no-completion	during completing-read
-    y-or-n-p		when you type something other than 'y' or 'n'
-    yes-or-no-p  	when you type something other than 'yes' or 'no'
-    default		used when nothing else is appropriate.
-
-Other lisp packages may use other beep types, but these are the ones that
-the C kernel of Emacs uses.
+Sound symbols that map directly to data should be considered named sounds;
+sound symbols that map to other sounds should be considered abstract
+sounds, and are used when a particular behavior or state occurs.  See
+`ding' for a list of the standard abstract sounds.
 */ );
   Vsound_alist = Qnil;