annotate src/README @ 613:023b83f4e54b

[xemacs-hg @ 2001-06-10 10:42:16 by ben] ------ signal-code changes ------ data.c, device-tty.c, emacs.c, floatfns.c, linuxplay.c, nas.c, process-unix.c, signal.c, sunplay.c, sysdep.c, syssignal.h: use EMACS_SIGNAL everywhere instead of playing preprocessing games with signal(). s\windowsnt.h, s\mingw32.h, syssignal.h: Remove mswindows signal code from s+m headers and move to syssignal.h as one of the five ways of signal handling, instead of playing preprocessing games. fileio.c, sysdep.c: Rename sys_do_signal to qxe_reliable_signal. signal.c, process-unix.c, profile.c: Create set_timeout_signal(); use instead of just EMACS_SIGNAL to establish a signal handler on a timeout signal; this does special things under Cygwin. nt.c: Eliminate term_ntproc(), which is blank; used as a SIGABRT handler, which was wrong anyway. nt.c, win32.c: Move signal code from nt.c to win32.c, since Cygwin needs it too when dealing with timeout signals. s\cygwin32.h: Define CYGWIN_BROKEN_SIGNALS. ------ other changes ------ s\mingw32.h: Fix problems with NOT_C_CODE being in the wrong place and excluding defines needed when building Makefile.in.in. filelock.c, mule-canna.c, mule-ccl.c, mule-ccl.h, ralloc.c, unexalpha.c, unexapollo.c, unexcw.c, unexelfsgi.c, unexnt.c, unexsni.c, s\aix3-1.h, s\bsd4-1.h, s\bsd4-2.h, s\bsd4-3.h, s\cxux.h, s\cygwin32.h, s\dgux.h, s\dgux5-4r2.h, s\dgux5-4r3.h, s\dgux5-4r4.h, s\ewsux5r4.h, s\gnu.h, s\hpux.h, s\iris3-5.h, s\iris3-6.h, s\irix3-3.h, s\linux.h, s\mingw32.h, s\newsos5.h, s\nextstep.h, s\ptx.h, s\riscix1-1.h, s\riscix1-2.h, s\rtu.h, s\sco4.h, s\sco5.h, s\template.h, s\ultrix.h, s\umax.h, s\umips.h, s\unipl5-0.h, s\unipl5-2.h, s\usg5-0.h, s\usg5-2-2.h, s\usg5-2.h, s\usg5-3.h, s\usg5-4.h, s\windowsnt.h, s\xenix.h: Rename 'GNU Emacs' to XEmacs in the copyright and comments. nas.c: Stylistic cleanup. Avoid preprocessing games with names such as play_sound_file. ------ signal-code changes ------ data.c, device-tty.c, emacs.c, floatfns.c, linuxplay.c, nas.c, process-unix.c, signal.c, sunplay.c, sysdep.c, syssignal.h: use EMACS_SIGNAL everywhere instead of playing preprocessing games with signal(). s\windowsnt.h, s\mingw32.h, syssignal.h: Remove mswindows signal code from s+m headers and move to syssignal.h as one of the five ways of signal handling, instead of playing preprocessing games. fileio.c, sysdep.c: Rename sys_do_signal to qxe_reliable_signal. signal.c, process-unix.c, profile.c: Create set_timeout_signal(); use instead of just EMACS_SIGNAL to establish a signal handler on a timeout signal; this does special things under Cygwin. nt.c: Eliminate term_ntproc(), which is blank; used as a SIGABRT handler, which was wrong anyway. nt.c, win32.c: Move signal code from nt.c to win32.c, since Cygwin needs it too when dealing with timeout signals. s\cygwin32.h: Define CYGWIN_BROKEN_SIGNALS. ------ other changes ------ s\mingw32.h: Fix problems with NOT_C_CODE being in the wrong place and excluding defines needed when building Makefile.in.in. filelock.c, mule-canna.c, mule-ccl.c, mule-ccl.h, ralloc.c, unexalpha.c, unexapollo.c, unexcw.c, unexelfsgi.c, unexnt.c, unexsni.c, s\aix3-1.h, s\bsd4-1.h, s\bsd4-2.h, s\bsd4-3.h, s\cxux.h, s\cygwin32.h, s\dgux.h, s\dgux5-4r2.h, s\dgux5-4r3.h, s\dgux5-4r4.h, s\ewsux5r4.h, s\gnu.h, s\hpux.h, s\iris3-5.h, s\iris3-6.h, s\irix3-3.h, s\linux.h, s\mingw32.h, s\newsos5.h, s\nextstep.h, s\ptx.h, s\riscix1-1.h, s\riscix1-2.h, s\rtu.h, s\sco4.h, s\sco5.h, s\template.h, s\ultrix.h, s\umax.h, s\umips.h, s\unipl5-0.h, s\unipl5-2.h, s\usg5-0.h, s\usg5-2-2.h, s\usg5-2.h, s\usg5-3.h, s\usg5-4.h, s\windowsnt.h, s\xenix.h: Rename 'GNU Emacs' to XEmacs in the copyright and comments. nas.c: Stylistic cleanup. Avoid preprocessing games with names such as play_sound_file. xemacs-faq.texi: Update sections on Windows and MacOS availability. alist.el, apropos.el, autoload.el, bytecomp.el, cl-compat.el, cl-extra.el, cl-macs.el, cl-seq.el, cl.el, cmdloop.el, cus-edit.el, derived.el, gpm.el, itimer.el, lisp-mode.el, shadow.el, version.el, wid-browse.el: Rename 'GNU Emacs' to XEmacs in the copyright. Fix other references to GNU Emacs that should be XEmacs or just Emacs. files.el: Fix warning. simple.el: transpose-line-up/down will now move the region up or down by a line if active. cvtmail.c, fakemail.c, gnuserv.c, gnuserv.h, gnuslib.c, make-msgfile.c, make-path.c, pop.c, pop.h, profile.c, tcp.c: Rename 'GNU Emacs' to XEmacs in the copyright. Fix comments in similar ways. digest-doc.c, sorted-doc.c: Fix program and author name to reflect XEmacs.
author ben
date Sun, 10 Jun 2001 10:42:39 +0000
parents abe6d1db359e
children 304aebb79cd3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 This directory contains the source files for the C component of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 Nothing in this directory is needed for using XEmacs once it is built
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 and installed, if the dumped Emacs is copied elsewhere.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 See the files ../README and then ../INSTALL for installation instructions.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 Under Unix, the file `Makefile.in.in' is used as a template by the script
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 `../configure' to produce `Makefile.in'. The same script then uses `cpp'
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 to produce the machine-dependent `Makefile' from `Makefile.in';
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 `Makefile' is the file which actually controls the compilation of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 Emacs. Most of this should work transparently to the user; you should
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 only need to run `../configure', and then type `make'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 General changes for XEmacs:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 ---------------------------
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 1. Lisp objects.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 -- XFASTINT has been eliminated. Use of this expression as an lvalue
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 is incompatible with the union form of Lisp objects, and use as
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 an rvalue is likely to lead to errors and doesn't really save much
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 time. Expressions of the form `XFASTINT (obj) = num;' get replaced
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 by `obj = make_int (num);' or `XSETINT (obj, num);' and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 expressions of the form `num = XFASTINT (obj);' get replaced by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 `num = XINT (obj);'. Use Qzero in place of `make_int (0)'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 -- Use of XTYPE gets replaced by the appropriate predicate. Using
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 XTYPE only works for the small number of types that are not stored
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 using the Lisp_Record type (int, cons, string, and vector). For
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 example, `(XTYPE (foo) == Lisp_Buffer)' gets replaced by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 `(BUFFERP (foo))'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 -- `XSET (obj, Lisp_Int, num)' gets replaced by `XSETINT (obj, num)',
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 for consistency.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 -- Some occurrences of XSET need to get replaced by XSETR --
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 specifically, those where the type is not a primitive type
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 (primitive types are int, cons, string, and vector).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 -- References to `XSTRING (obj)->size' get replaced with
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 `XSTRING_LENGTH (obj)'. This is currently for cosmetic reasons
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 but there may be other reasons in the future. (This change is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 currently incomplete in the source files.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 2. Storage classes:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 -- All occurrences of `register' should be replaced by `REGISTER'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 It interferes with backtraces so we disable it if DEBUG_XEMACS
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 is defined.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 3. Errors, messages, I18N3 snarfing:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 -- Errors are continuable in XEmacs but are not in FSF Emacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 Therefore, it's important that functions do something reasonable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 if an error gets continued. If you want to signal a non-
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 continuable error, the call to Fsignal() gets put inside a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 `while (1)' loop. To facilitate this, and also for proper I18N3
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 message snarfing, most calls to Fsignal() have been replaced by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 calls to signal_error(), signal_simple_error(), etc. Look at
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 eval.c for a classification of various error functions.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 -- Constant strings occurring in source files need to get wrapped
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 in a call to GETTEXT (or if inside of a call to `build_string',
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 change that function to `build_translated_string') if they don't
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 occur in certain places where the I18N3 message snarfer will see
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 them. For a complete discussion of this, see the file
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 lib-src/make-msgfile.lex.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 NOTE: I18N3 support is not currently working, so the above may
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 or may not apply. Thus it is not a good idea to add random
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 GETTEXTs, unless you really know what you are doing.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 -- Calls to `fprintf (stderr, ...)' and `printf (...)' get replaced
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 with calls to `stderr_out' and `stdout_out'. This is for I18N3
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 message snarfing.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 4. Initialization:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 -- FSF constructs like `obj = intern ("string"); staticpro (&obj);'
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 get replaced by `defsymbol (&obj);'. This is for code cleanness
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 and better purespace usage.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 -- FSF constructs like
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 obj = intern ("error");
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 Fput (obj, Qerror_message, "message");
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 Fput (obj, Qerror_conditions, some list);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 get replaced by calls to deferror(). See the definition of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 deferror() for how the correct arguments to pass. This is for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 code cleanness and I18N3 message snarfing.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 -- Code in keys_of_foo() functions has been moved into Lisp.