view src/README @ 826:6728e641994e

[xemacs-hg @ 2002-05-05 11:30:15 by ben] syntax cache, 8-bit-format, lots of code cleanup README.packages: Update info about --package-path. i.c: Create an inheritable event and pass it on to XEmacs, so that ^C can be handled properly. Intercept ^C and signal the event. "Stop Build" in VC++ now works. bytecomp-runtime.el: Doc string changes. compat.el: Some attempts to redo this to make it truly useful and fix the "multiple versions interacting with each other" problem. Not yet done. Currently doesn't work. files.el: Use with-obsolete-variable to avoid warnings in new revert-buffer code. xemacs.mak: Split up CFLAGS into a version without flags specifying the C library. The problem seems to be that minitar depends on zlib, which depends specifically on libc.lib, not on any of the other C libraries. Unless you compile with libc.lib, you get errors -- specifically, no _errno in the other libraries, which must make it something other than an int. (#### But this doesn't seem to obtain in XEmacs, which also uses zlib, and can be linked with any of the C libraries. Maybe zlib is used differently and doesn't need errno, or maybe XEmacs provides an int errno; ... I don't understand. Makefile.in.in: Fix so that packages are around when testing. abbrev.c, alloc.c, buffer.c, buffer.h, bytecode.c, callint.c, casefiddle.c, casetab.c, casetab.h, charset.h, chartab.c, chartab.h, cmds.c, console-msw.h, console-stream.c, console-x.c, console.c, console.h, data.c, device-msw.c, device.c, device.h, dialog-msw.c, dialog-x.c, dired-msw.c, dired.c, doc.c, doprnt.c, dumper.c, editfns.c, elhash.c, emacs.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, events.c, events.h, extents.c, extents.h, faces.c, file-coding.c, file-coding.h, fileio.c, fns.c, font-lock.c, frame-gtk.c, frame-msw.c, frame-x.c, frame.c, frame.h, glade.c, glyphs-gtk.c, glyphs-msw.c, glyphs-msw.h, glyphs-x.c, glyphs.c, glyphs.h, gui-msw.c, gui-x.c, gui.h, gutter.h, hash.h, indent.c, insdel.c, intl-win32.c, intl.c, keymap.c, 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-ccl.c, mule-charset.c, mule-coding.c, mule-wnnfns.c, nas.c, objects-msw.c, objects-x.c, opaque.c, postgresql.c, print.c, process-nt.c, process-unix.c, process.c, process.h, profile.c, rangetab.c, redisplay-gtk.c, redisplay-msw.c, redisplay-output.c, redisplay-x.c, redisplay.c, redisplay.h, regex.c, regex.h, scrollbar-msw.c, search.c, select-x.c, specifier.c, specifier.h, symbols.c, symsinit.h, syntax.c, syntax.h, syswindows.h, tests.c, text.c, text.h, tooltalk.c, ui-byhand.c, ui-gtk.c, unicode.c, win32.c, window.c: Another big Ben patch. -- FUNCTIONALITY CHANGES: add partial support for 8-bit-fixed, 16-bit-fixed, and 32-bit-fixed formats. not quite done yet. (in particular, needs functions to actually convert the buffer.) NOTE: lots of changes to regex.c here. also, many new *_fmt() inline funs that take an Internal_Format argument. redo syntax cache code. make the cache per-buffer; keep the cache valid across calls to functions that use it. also keep it valid across insertions/deletions and extent changes, as much as is possible. eliminate the junky regex-reentrancy code by passing in the relevant lisp info to the regex routines as local vars. add general mechanism in extents code for signalling extent changes. fix numerous problems with the case-table implementation; yoshiki never properly transferred many algorithms from old-style to new-style case tables. redo char tables to support a default argument, so that mapping only occurs over changed args. change many chartab functions to accept Lisp_Object instead of Lisp_Char_Table *. comment out the code in font-lock.c by default, because font-lock.el no longer uses it. we should consider eliminating it entirely. Don't output bell as ^G in console-stream when not a TTY. add -mswindows-termination-handle to interface with i.c, so we can properly kill a build. add more error-checking to buffer/string macros. add some additional buffer_or_string_() funs. -- INTERFACE CHANGES AFFECTING MORE CODE: switch the arguments of write_c_string and friends to be consistent with write_fmt_string, which must have printcharfun first. change BI_* macros to BYTE_* for increased clarity; similarly for bi_* local vars. change VOID_TO_LISP to be a one-argument function. eliminate no-longer-needed CVOID_TO_LISP. -- char/string macro changes: rename MAKE_CHAR() to make_emchar() for slightly less confusion with make_char(). (The former generates an Emchar, the latter a Lisp object. Conceivably we should rename make_char() -> wrap_char() and similarly for make_int(), make_float().) Similar changes for other *CHAR* macros -- we now consistently use names with `emchar' whenever we are working with Emchars. Any remaining name with just `char' always refers to a Lisp object. rename macros with XSTRING_* to string_* except for those that reference actual fields in the Lisp_String object, following conventions used elsewhere. rename set_string_{data,length} macros (the only ones to work with a Lisp_String_* instead of a Lisp_Object) to set_lispstringp_* to make the difference clear. try to be consistent about caps vs. lowercase in macro/inline-fun names for chars and such, which wasn't the case before. we now reserve caps either for XFOO_ macros that reference object fields (e.g. XSTRING_DATA) or for things that have non-function semantics, e.g. directly modifying an arg (BREAKUP_EMCHAR) or evaluating an arg (any arg) more than once. otherwise, use lowercase. here is a summary of most of the macros/inline funs changed by all of the above changes: BYTE_*_P -> byte_*_p XSTRING_BYTE -> string_byte set_string_data/length -> set_lispstringp_data/length XSTRING_CHAR_LENGTH -> string_char_length XSTRING_CHAR -> string_emchar INTBYTE_FIRST_BYTE_P -> intbyte_first_byte_p INTBYTE_LEADING_BYTE_P -> intbyte_leading_byte_p charptr_copy_char -> charptr_copy_emchar LEADING_BYTE_* -> leading_byte_* CHAR_* -> EMCHAR_* *_CHAR_* -> *_EMCHAR_* *_CHAR -> *_EMCHAR CHARSET_BY_ -> charset_by_* BYTE_SHIFT_JIS* -> byte_shift_jis* BYTE_BIG5* -> byte_big5* REP_BYTES_BY_FIRST_BYTE -> rep_bytes_by_first_byte char_to_unicode -> emchar_to_unicode valid_char_p -> valid_emchar_p Change intbyte_strcmp -> qxestrcmp_c (duplicated functionality). -- INTERFACE CHANGES AFFECTING LESS CODE: use DECLARE_INLINE_HEADER in various places. remove '#ifdef emacs' from XEmacs-only files. eliminate CHAR_TABLE_VALUE(), which duplicated the functionality of get_char_table(). add BUFFER_TEXT_LOOP to simplify iterations over buffer text. define typedefs for signed and unsigned types of fixed sizes (INT_32_BIT, UINT_32_BIT, etc.). create ALIGN_FOR_TYPE as a higher-level interface onto ALIGN_SIZE; fix code to use it. add charptr_emchar_len to return the text length of the character pointed to by a ptr; use it in place of charcount_to_bytecount(..., 1). add emchar_len to return the text length of a given character. add types Bytexpos and Charxpos to generalize Bytebpos/Bytecount and Charbpos/Charcount, in code (particularly, the extents code and redisplay code) that works with either kind of index. rename redisplay struct params with names such as `charbpos' to e.g. `charpos' when they are e.g. a Charxpos, not a Charbpos. eliminate xxDEFUN in place of DEFUN; no longer necessary with changes awhile back to doc.c. split up big ugly combined list of EXFUNs in lisp.h on a file-by-file basis, since other prototypes are similarly split. rewrite some "*_UNSAFE" macros as inline funs and eliminate the _UNSAFE suffix. move most string code from lisp.h to text.h; the string code and text.h code is now intertwined in such a fashion that they need to be in the same place and partially interleaved. (you can't create forward references for inline funs) automated/lisp-tests.el, automated/symbol-tests.el, automated/test-harness.el: Fix test harness to output FAIL messages to stderr when in batch mode. Fix up some problems in lisp-tests/symbol-tests that were causing spurious failures.
author ben
date Sun, 05 May 2002 11:33:57 +0000
parents abe6d1db359e
children 304aebb79cd3
line wrap: on
line source

This directory contains the source files for the C component of XEmacs.
Nothing in this directory is needed for using XEmacs once it is built
and installed, if the dumped Emacs is copied elsewhere.

See the files ../README and then ../INSTALL for installation instructions.

Under Unix, the file `Makefile.in.in' is used as a template by the script
`../configure' to produce `Makefile.in'.  The same script then uses `cpp'
to produce the machine-dependent `Makefile' from `Makefile.in';
`Makefile' is the file which actually controls the compilation of
Emacs.  Most of this should work transparently to the user; you should
only need to run `../configure', and then type `make'.

General changes for XEmacs:
---------------------------
1. Lisp objects.

   -- XFASTINT has been eliminated.  Use of this expression as an lvalue
      is incompatible with the union form of Lisp objects, and use as
      an rvalue is likely to lead to errors and doesn't really save much
      time.  Expressions of the form `XFASTINT (obj) = num;' get replaced
      by `obj = make_int (num);' or `XSETINT (obj, num);' and
      expressions of the form `num = XFASTINT (obj);' get replaced by
      `num = XINT (obj);'.  Use Qzero in place of `make_int (0)'.

   -- Use of XTYPE gets replaced by the appropriate predicate.  Using
      XTYPE only works for the small number of types that are not stored
      using the Lisp_Record type (int, cons, string, and vector).  For
      example, `(XTYPE (foo) == Lisp_Buffer)' gets replaced by
      `(BUFFERP (foo))'.

   -- `XSET (obj, Lisp_Int, num)' gets replaced by `XSETINT (obj, num)',
      for consistency.

   -- Some occurrences of XSET need to get replaced by XSETR --
      specifically, those where the type is not a primitive type
      (primitive types are int, cons, string, and vector).

   -- References to `XSTRING (obj)->size' get replaced with
      `XSTRING_LENGTH (obj)'.  This is currently for cosmetic reasons
      but there may be other reasons in the future.  (This change is
      currently incomplete in the source files.)


2. Storage classes:

   -- All occurrences of `register' should be replaced by `REGISTER'.
      It interferes with backtraces so we disable it if DEBUG_XEMACS
      is defined.


3. Errors, messages, I18N3 snarfing:

   -- Errors are continuable in XEmacs but are not in FSF Emacs.
      Therefore, it's important that functions do something reasonable
      if an error gets continued.  If you want to signal a non-
      continuable error, the call to Fsignal() gets put inside a
      `while (1)' loop.  To facilitate this, and also for proper I18N3
      message snarfing, most calls to Fsignal() have been replaced by
      calls to signal_error(), signal_simple_error(), etc.  Look at
      eval.c for a classification of various error functions.

   -- Constant strings occurring in source files need to get wrapped
      in a call to GETTEXT (or if inside of a call to `build_string',
      change that function to `build_translated_string') if they don't
      occur in certain places where the I18N3 message snarfer will see
      them.  For a complete discussion of this, see the file
      lib-src/make-msgfile.lex.

      NOTE: I18N3 support is not currently working, so the above may
      or may not apply.  Thus it is not a good idea to add random
      GETTEXTs, unless you really know what you are doing.

   -- Calls to `fprintf (stderr, ...)' and `printf (...)' get replaced
      with calls to `stderr_out' and `stdout_out'.  This is for I18N3
      message snarfing.

4. Initialization:

   -- FSF constructs like `obj = intern ("string"); staticpro (&obj);'
      get replaced by `defsymbol (&obj);'.  This is for code cleanness
      and better purespace usage.
   -- FSF constructs like
        obj = intern ("error");
        Fput (obj, Qerror_message, "message");
	Fput (obj, Qerror_conditions, some list);
      get replaced by calls to deferror().  See the definition of
      deferror() for how the correct arguments to pass.  This is for
      code cleanness and I18N3 message snarfing.
   -- Code in keys_of_foo() functions has been moved into Lisp.