diff src/symeval.h @ 563:183866b06e0b

[xemacs-hg @ 2001-05-24 07:50:48 by ben] Makefile.in.in, abbrev.c, alloc.c, buffer.c, bytecode.c, callint.c, callproc.c, casetab.c, chartab.c, cmdloop.c, cmds.c, console-msw.c, console-msw.h, console-stream.c, console-tty.c, console-x.c, console.c, data.c, database.c, debug.c, device-gtk.c, device-msw.c, device-tty.c, device-x.c, device.c, dialog-gtk.c, dialog-msw.c, dialog-x.c, dialog.c, dired-msw.c, dired.c, doc.c, doprnt.c, dragdrop.c, editfns.c, eldap.c, eldap.h, elhash.c, emacs-widget-accessors.c, emacs.c, emodules.c, esd.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, events.c, extents.c, faces.c, file-coding.c, fileio.c, filelock.c, floatfns.c, fns.c, font-lock.c, frame-gtk.c, frame-x.c, frame.c, general-slots.h, glade.c, glyphs-gtk.c, glyphs-msw.c, glyphs-widget.c, glyphs-x.c, glyphs.c, glyphs.h, gpmevent.c, gui-gtk.c, gui-x.c, gui.c, gutter.c, hpplay.c, indent.c, input-method-xlib.c, insdel.c, intl.c, keymap.c, libsst.c, libsst.h, linuxplay.c, lisp.h, lread.c, lstream.c, lstream.h, macros.c, marker.c, md5.c, menubar-gtk.c, menubar-msw.c, menubar-x.c, menubar.c, minibuf.c, miscplay.c, miscplay.h, mule-ccl.c, mule-charset.c, mule-wnnfns.c, mule.c, nas.c, ntplay.c, ntproc.c, objects-gtk.c, objects-msw.c, objects-x.c, objects.c, postgresql.c, print.c, process-nt.c, process-unix.c, process.c, ralloc.c, rangetab.c, redisplay.c, scrollbar.c, search.c, select-gtk.c, select-x.c, select.c, sgiplay.c, sheap.c, sound.c, specifier.c, sunplay.c, symbols.c, symeval.h, symsinit.h, syntax.c, sysdep.c, toolbar-msw.c, toolbar.c, tooltalk.c, ui-byhand.c, ui-gtk.c, undo.c, unexaix.c, unexapollo.c, unexconvex.c, unexec.c, widget.c, win32.c, window.c: -- defsymbol -> DEFSYMBOL. -- add an error type to all errors. -- eliminate the error functions in eval.c that let you just use Qerror as the type. -- redo the error API to be more consistent, sensibly named, and easier to use. -- redo the error hierarchy somewhat. create new errors: structure-formation-error, gui-error, invalid-constant, stack-overflow, out-of-memory, process-error, network-error, sound-error, printing-unreadable-object, base64-conversion- error; coding-system-error renamed to text-conversion error; some others. -- fix Mule problems in error strings in emodules.c, tooltalk.c. -- fix error handling in mswin open-network-stream. -- Mule-ize all sound files and clean up the headers. -- nativesound.h -> sound.h and used for all sound files. -- move some shared stuff into glyphs-shared.c: first attempt at eliminating some of the massive GTK code duplication. xemacs.mak: add glyphs-shared.c. xemacs-faq.texi: document how to debug X errors subr.el: fix doc string to reflect reality
author ben
date Thu, 24 May 2001 07:51:33 +0000
parents c33ae14dd6d0
children 943eaba38521
line wrap: on
line diff
--- a/src/symeval.h	Thu May 24 06:30:21 2001 +0000
+++ b/src/symeval.h	Thu May 24 07:51:33 2001 +0000
@@ -294,6 +294,32 @@
 void defsymbol (Lisp_Object *location, const char *name);
 void defsymbol_nodump (Lisp_Object *location, const char *name);
 
+/* Defining symbols:
+
+   (1) A standard symbol is defined with DEFSYMBOL.  That means that
+       the symbol's print name can be derived from the symbol's variable
+       name by removing the initial Q and replacing underscores with hyphens.
+   (2) A keyword symbol is defined with DEFKEYWORD.  That means that
+       the symbol's print name can be derived from the symbol's variable
+       name by removing the initial Q and replacing underscores with hyphens,
+       except that the initial underscore, which comes directly after the Q,
+       is replaced by a colon.
+   (3) DEFSYMBOL_MULTIWORD_PREDICATE is used for the predicates that are
+       associated with a particular type of Lisp Object.  Because of the
+       limitations of C macros, they're always given a predicate symbol
+       whose C name simply appends `p' to the type name, modulo hyphen/
+       underscore conversion.  Properly, however, the Lisp name should have
+       `-p' if there is more than one word in the type name.
+       DEFSYMBOL_MULTIWORD_PREDICATE is for these weird symbols -- the
+       C name as supplied to the macro should end with a `p' with no
+       underscore before it, and the macro will insert a hyphen there in
+       the Lisp name.
+   (4) In case you have some weird symbol where the equivalence between
+       the C and Lisp names is more complicated (e.g. the Lisp symbol has
+       non-alphabetic, non-numeric characters in it), you can just call
+       defsymbol() (the lowercase version) directly.
+*/
+
 #define DEFSYMBOL(name) defsymbol_massage_name (&name, #name)
 #define DEFSYMBOL_NO_DUMP(name) defsymbol_massage_name_nodump (&name, #name)
 #define DEFSYMBOL_MULTIWORD_PREDICATE(name) \