annotate src/README @ 4906:6ef8256a020a

implement equalp in C, fix case-folding, add equal() method for keymaps -------------------- ChangeLog entries follow: -------------------- lisp/ChangeLog addition: 2010-02-01 Ben Wing <ben@xemacs.org> * cl-extra.el: * cl-extra.el (cl-string-vector-equalp): Removed. * cl-extra.el (cl-bit-vector-vector-equalp): Removed. * cl-extra.el (cl-vector-array-equalp): Removed. * cl-extra.el (cl-hash-table-contents-equalp): Removed. * cl-extra.el (equalp): Removed. * cl-extra.el (cl-mapcar-many): Comment out the whole `equalp' implementation for the moment; remove once we're sure the C implementation works. * cl-macs.el: * cl-macs.el (equalp): Simplify the compiler-macro for `equalp' -- once it's in C, we don't need to try so hard to expand it. src/ChangeLog addition: 2010-02-01 Ben Wing <ben@xemacs.org> * abbrev.c (abbrev_match_mapper): * buffer.h (CANON_TABLE_OF): * buffer.h: * editfns.c (Fchar_equal): * minibuf.c (scmp_1): * text.c (qxestrcasecmp_i18n): * text.c (qxestrncasecmp_i18n): * text.c (qxetextcasecmp): * text.c (qxetextcasecmp_matching): Create new macro CANONCASE that converts to a canonical mapping and use it to do caseless comparisons instead of DOWNCASE. * alloc.c: * alloc.c (cons_equal): * alloc.c (vector_equal): * alloc.c (string_equal): * bytecode.c (compiled_function_equal): * chartab.c (char_table_entry_equal): * chartab.c (char_table_equal): * data.c (weak_list_equal): * data.c (weak_box_equal): * data.c (ephemeron_equal): * device-msw.c (equal_devmode): * elhash.c (hash_table_equal): * events.c (event_equal): * extents.c (properties_equal): * extents.c (extent_equal): * faces.c: * faces.c (face_equal): * faces.c (face_hash): * floatfns.c (float_equal): * fns.c: * fns.c (bit_vector_equal): * fns.c (plists_differ): * fns.c (Fplists_eq): * fns.c (Fplists_equal): * fns.c (Flax_plists_eq): * fns.c (Flax_plists_equal): * fns.c (internal_equal): * fns.c (internal_equalp): * fns.c (internal_equal_0): * fns.c (syms_of_fns): * glyphs.c (image_instance_equal): * glyphs.c (glyph_equal): * glyphs.c (glyph_hash): * gui.c (gui_item_equal): * lisp.h: * lrecord.h (struct lrecord_implementation): * marker.c (marker_equal): * number.c (bignum_equal): * number.c (ratio_equal): * number.c (bigfloat_equal): * objects.c (color_instance_equal): * objects.c (font_instance_equal): * opaque.c (equal_opaque): * opaque.c (equal_opaque_ptr): * rangetab.c (range_table_equal): * specifier.c (specifier_equal): Add a `foldcase' param to the equal() method and use it to implement `equalp' comparisons. Also add to plists_differ(), although we don't currently use it here. Rewrite internal_equalp(). Implement cross-type vector comparisons. Don't implement our own handling of numeric promotion -- just use the `=' primitive. Add internal_equal_0(), which takes a `foldcase' param and calls either internal_equal() or internal_equalp(). * buffer.h: When given a 0 for buffer (which is the norm when functions don't have a specific buffer available), use the current buffer's table, not `standard-case-table'; otherwise the current settings are ignored. * casetab.c: * casetab.c (set_case_table): When handling old-style vectors of 256 in `set-case-table' don't overwrite the existing table! Instead create a new table and populate. * device-msw.c (sync_printer_with_devmode): * lisp.h: * text.c (lisp_strcasecmp_ascii): Rename lisp_strcasecmp to lisp_strcasecmp_ascii and use lisp_strcasecmp_i18n for caseless comparisons in some places. * elhash.c: Delete unused lisp_string_hash and lisp_string_equal(). * events.h: * keymap-buttons.h: * keymap.h: * keymap.c (keymap_lookup_directly): * keymap.c (keymap_store): * keymap.c (FROB): * keymap.c (key_desc_list_to_event): * keymap.c (describe_map_mapper): * keymap.c (INCLUDE_BUTTON_ZERO): New file keymap-buttons.h; use to handle buttons 1-26 in place of duplicating code 26 times. * frame-gtk.c (allocate_gtk_frame_struct): * frame-msw.c (mswindows_init_frame_1): Fix some comments about internal_equal() in redisplay that don't apply any more. * keymap-slots.h: * keymap.c: New file keymap-slots.h. Use it to notate the slots in a keymap structure, similar to frameslots.h or coding-system-slots.h. * keymap.c (MARKED_SLOT): * keymap.c (keymap_equal): * keymap.c (keymap_hash): Implement. tests/ChangeLog addition: 2010-02-01 Ben Wing <ben@xemacs.org> * automated/case-tests.el: * automated/case-tests.el (uni-mappings): * automated/search-tests.el: Delete old pristine-case-table code. Rewrite the Unicode torture test to take into account whether overlapping mappings exist for more than one character, and not doing the upcase/downcase comparisons in such cases. * automated/lisp-tests.el (foo): * automated/lisp-tests.el (string-variable): * automated/lisp-tests.el (featurep): Replace Assert (equal ... with Assert-equal; same for other types of equality. Replace some awkward equivalents of Assert-equalp with Assert-equalp. Add lots of equalp tests. * automated/case-tests.el: * automated/regexp-tests.el: * automated/search-tests.el: Fix up the comments at the top of the files. Move rules about where to put tests into case-tests.el. * automated/test-harness.el: * automated/test-harness.el (test-harness-aborted-summary-template): New. * automated/test-harness.el (test-harness-from-buffer): * automated/test-harness.el (batch-test-emacs): Fix Assert-test-not. Create Assert-not-equal and variants. Delete the doc strings from all these convenience functions to avoid excessive repetition; instead use one copy in a comment.
author Ben Wing <ben@xemacs.org>
date Mon, 01 Feb 2010 01:02:40 -0600
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.