annotate src/README @ 5366:f00192e1cd49

Examining the result of #'length: `eql', not `=', it's better style & cheaper 2011-03-08 Aidan Kehoe <kehoea@parhasard.net> * buff-menu.el (list-buffers-noselect): * byte-optimize.el (byte-optimize-identity): * byte-optimize.el (byte-optimize-if): * byte-optimize.el (byte-optimize-nth): * byte-optimize.el (byte-optimize-nthcdr): * bytecomp.el (byte-compile-warn-wrong-args): * bytecomp.el (byte-compile-two-args-19->20): * bytecomp.el (byte-compile-list): * bytecomp.el (byte-compile-beginning-of-line): * bytecomp.el (byte-compile-set): * bytecomp.el (byte-compile-set-default): * bytecomp.el (byte-compile-values): * bytecomp.el (byte-compile-values-list): * bytecomp.el (byte-compile-integerp): * bytecomp.el (byte-compile-multiple-value-list-internal): * bytecomp.el (byte-compile-throw): * cl-macs.el (cl-do-arglist): * cl-macs.el (cl-parse-loop-clause): * cl-macs.el (multiple-value-bind): * cl-macs.el (multiple-value-setq): * cl-macs.el (get-setf-method): * cmdloop.el (command-error): * cmdloop.el (y-or-n-p-minibuf): * cmdloop.el (yes-or-no-p-minibuf): * coding.el (unencodable-char-position): * cus-edit.el (custom-face-prompt): * cus-edit.el (custom-buffer-create-internal): * cus-edit.el (widget-face-action): * cus-edit.el (custom-group-value-create): * descr-text.el (describe-char-unicode-data): * dialog-gtk.el (popup-builtin-question-dialog): * dragdrop.el (experimental-dragdrop-drop-log-function): * dragdrop.el (experimental-dragdrop-drop-mime-default): * easymenu.el (easy-menu-add): * easymenu.el (easy-menu-remove): * faces.el (read-face-name): * faces.el (set-face-stipple): * files.el (file-name-non-special): * font.el (font-combine-fonts): * font.el (font-set-face-font): * font.el (font-parse-rgb-components): * font.el (font-rgb-color-p): * font.el (font-color-rgb-components): * gnuserv.el (gnuserv-edit-files): * help.el (key-or-menu-binding): * help.el (function-documentation-1): * help.el (function-documentation): * info.el (info): * isearch-mode.el (isearch-exit): * isearch-mode.el (isearch-edit-string): * isearch-mode.el (isearch-*-char): * isearch-mode.el (isearch-complete1): * ldap.el (ldap-encode-country-string): * ldap.el (ldap-decode-string): * minibuf.el (read-file-name-internal-1): * minibuf.el (read-non-nil-coding-system): * minibuf.el (get-user-response): * mouse.el (drag-window-divider): * mule/ccl.el: * mule/ccl.el (ccl-compile-if): * mule/ccl.el (ccl-compile-break): * mule/ccl.el (ccl-compile-repeat): * mule/ccl.el (ccl-compile-write-repeat): * mule/ccl.el (ccl-compile-call): * mule/ccl.el (ccl-compile-end): * mule/ccl.el (ccl-compile-read-multibyte-character): * mule/ccl.el (ccl-compile-write-multibyte-character): * mule/ccl.el (ccl-compile-translate-character): * mule/ccl.el (ccl-compile-mule-to-unicode): * mule/ccl.el (ccl-compile-unicode-to-mule): * mule/ccl.el (ccl-compile-lookup-integer): * mule/ccl.el (ccl-compile-lookup-character): * mule/ccl.el (ccl-compile-map-multiple): * mule/ccl.el (ccl-compile-map-single): * mule/devan-util.el (devanagari-compose-to-one-glyph): * mule/devan-util.el (devanagari-composition-component): * mule/mule-cmds.el (finish-set-language-environment): * mule/viet-util.el: * mule/viet-util.el (viet-encode-viscii-char): * multicast.el (open-multicast-group): * newcomment.el (comment-quote-nested): * newcomment.el (comment-region): * newcomment.el (comment-dwim): * regexp-opt.el (regexp-opt-group): * replace.el (map-query-replace-regexp): * specifier.el (derive-device-type-from-tag-set): * subr.el (skip-chars-quote): * test-harness.el (test-harness-from-buffer): * test-harness.el (batch-test-emacs): * wid-edit.el (widget-choice-action): * wid-edit.el (widget-symbol-prompt-internal): * wid-edit.el (widget-color-action): * window-xemacs.el (push-window-configuration): * window-xemacs.el (pop-window-configuration): * window.el (quit-window): * x-compose.el (electric-diacritic): It's better style, and cheaper (often one assembler instruction vs. a C funcall in the byte code), to use `eql' instead of `=' when it's clear what numerical type a given result will be. Change much of our code to do this, with the help of a byte-compiler change (not comitted) that looked for calls to #'length (which always returns an integer) in its args.
author Aidan Kehoe <kehoea@parhasard.net>
date Tue, 08 Mar 2011 23:41:52 +0000
parents 304aebb79cd3
children 56144c8593a8
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
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.