annotate src/README @ 5607:1a507c4c6c42

Refactor out sequence-oriented builtins from fns.c to the new sequence.c. src/ChangeLog addition: 2011-12-04 Aidan Kehoe <kehoea@parhasard.net> * Makefile.in.in (objs): * depend: Add sequence.o to the list of objects and dependencies. * alloc.c: * alloc.c (mark_bit_vector): * alloc.c (print_bit_vector): * alloc.c (bit_vector_equal): * alloc.c (internal_bit_vector_equalp_hash): * alloc.c (bit_vector_hash): * alloc.c (init_alloc_once_early): Move the implementation of the bit vector type here from fns.c. * emacs.c (main_1): Call syms_of_sequence() here, now sequence.c is included. * fns.c (Fold_rassq): Move this together with the rest of the Fold_* functions. * fns.c: * fns.c (syms_of_fns): Move most functions dealing with sequences generally, and especially those taking key arguments, to a separate file, sequence.c. * general-slots.h: Qyes_or_no_p belong here, not fns.c. * lisp.h: Make Flist_length available here, it's used by sequence.c * sequence.c: * sequence.c (check_sequence_range): * sequence.c (Flength): * sequence.c (check_other_nokey): * sequence.c (check_other_key): * sequence.c (check_if_key): * sequence.c (check_match_eq_key): * sequence.c (check_match_eql_key): * sequence.c (check_match_equal_key): * sequence.c (check_match_equalp_key): * sequence.c (check_match_other_key): * sequence.c (check_lss_key): * sequence.c (check_lss_key_car): * sequence.c (check_string_lessp_key): * sequence.c (check_string_lessp_key_car): * sequence.c (get_check_match_function_1): * sequence.c (get_merge_predicate): * sequence.c (count_with_tail): * sequence.c (list_count_from_end): * sequence.c (string_count_from_end): * sequence.c (Fcount): * sequence.c (Fsubseq): * sequence.c (list_position_cons_before): * sequence.c (FmemberX): * sequence.c (Fadjoin): * sequence.c (FassocX): * sequence.c (FrassocX): * sequence.c (position): * sequence.c (Fposition): * sequence.c (Ffind): * sequence.c (delq_no_quit_and_free_cons): * sequence.c (FdeleteX): * sequence.c (FremoveX): * sequence.c (list_delete_duplicates_from_end): * sequence.c (Fdelete_duplicates): * sequence.c (Fremove_duplicates): * sequence.c (Fnreverse): * sequence.c (Freverse): * sequence.c (list_merge): * sequence.c (array_merge): * sequence.c (list_array_merge_into_list): * sequence.c (list_list_merge_into_array): * sequence.c (list_array_merge_into_array): * sequence.c (Fmerge): * sequence.c (list_sort): * sequence.c (array_sort): * sequence.c (FsortX): * sequence.c (Ffill): * sequence.c (mapcarX): * sequence.c (shortest_length_among_sequences): * sequence.c (Fmapconcat): * sequence.c (FmapcarX): * sequence.c (Fmapvector): * sequence.c (Fmapcan): * sequence.c (Fmap): * sequence.c (Fmap_into): * sequence.c (Fsome): * sequence.c (Fevery): * sequence.c (Freduce): * sequence.c (replace_string_range_1): * sequence.c (Freplace): * sequence.c (Fnsubstitute): * sequence.c (Fsubstitute): * sequence.c (subst): * sequence.c (sublis): * sequence.c (Fsublis): * sequence.c (nsublis): * sequence.c (Fnsublis): * sequence.c (Fsubst): * sequence.c (Fnsubst): * sequence.c (tree_equal): * sequence.c (Ftree_equal): * sequence.c (mismatch_from_end): * sequence.c (mismatch_list_list): * sequence.c (mismatch_list_string): * sequence.c (mismatch_list_array): * sequence.c (mismatch_string_array): * sequence.c (mismatch_string_string): * sequence.c (mismatch_array_array): * sequence.c (get_mismatch_func): * sequence.c (Fmismatch): * sequence.c (Fsearch): * sequence.c (venn): * sequence.c (nvenn): * sequence.c (Funion): * sequence.c (Fset_exclusive_or): * sequence.c (Fnset_exclusive_or): * sequence.c (syms_of_sequence): Add this file, containing those general functions that dealt with sequences that were in fns.c. * symsinit.h: Make syms_of_sequence() available here. man/ChangeLog addition: 2011-12-04 Aidan Kehoe <kehoea@parhasard.net> * internals/internals.texi (Basic Lisp Modules): Document sequence.c here too.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 04 Dec 2011 18:42:50 +0000
parents 56144c8593a8
children
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
5581
56144c8593a8 Mechanically change INT to FIXNUM in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents: 4953
diff changeset
22 by `obj = make_fixnum (num);' or `XSETINT (obj, num);' and
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 expressions of the form `num = XFASTINT (obj);' get replaced by
5581
56144c8593a8 Mechanically change INT to FIXNUM in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents: 4953
diff changeset
24 `num = XFIXNUM (obj);'. Use Qzero in place of `make_fixnum (0)'.
428
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
4953
304aebb79cd3 function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents: 442
diff changeset
64 in a call to GETTEXT (or if inside of a call to `build_ascstring',
428
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.