annotate etc/CODING-STANDARDS @ 1315:70921960b980

[xemacs-hg @ 2003-02-20 08:19:28 by ben] check in makefile fixes et al Makefile.in.in: Major surgery. Move all stuff related to building anything in the src/ directory into src/. Simplify the dependencies -- everything in src/ is dependent on the single entry `src' in MAKE_SUBDIRS. Remove weirdo targets like `all-elc[s]', dump-elc[s], etc. mule/mule-msw-init.el: Removed. Delete this file. mule/mule-win32-init.el: New file, with stuff from mule-msw-init.el -- not just for MS Windows native, boys and girls! bytecomp.el: Change code inserted to catch trying to load a Mule-only .elc file in a non-Mule XEmacs. Formerly you got the rather cryptic "The required feature `mule' cannot be provided". Now you get "Loading this file requires Mule support". finder.el: Remove dependency on which directory this function is invoked from. update-elc.el: Don't mess around with ../src/BYTECOMPILE_CHANGE. Now that Makefile.in.in and xemacs.mak are in sync, both of them use NEEDTODUMP and the other one isn't used. dumped-lisp.el: Rewrite in terms of `list' and `nconc' instead of assemble-list, so we can have arbitrary forms, not just `when-feature'. very-early-lisp.el: Nuke this file. finder-inf.el, packages.el, update-elc.el, update-elc-2.el, loadup.el, make-docfile.el: Eliminate references to very-early-lisp. msw-glyphs.el: Comment clarification. xemacs.mak: Add macros DO_TEMACS, DO_XEMACS, and a few others; this macro section is now completely in sync with src/Makefile.in.in. Copy check-features, load-shadows, and rebuilding finder-inf.el from src/Makefile.in.in. The main build/dump/recompile process is now synchronized with src/Makefile.in.in. Change `WARNING' to `NOTE' and `error checking' to `error-checking' TO avoid tripping faux warnings and errors in the VC++ IDE. Makefile.in.in: Major surgery. Move all stuff related to building anything in the src/ directory from top-level Makefile.in.in to here. Simplify the dependencies. Rearrange into logical subsections. Synchronize the main compile/dump/build-elcs section with xemacs.mak, which is already clean and in good working order. Remove weirdo targets like `all-elc[s]', dump-elc[s], etc. Add additional levels of macros \(e.g. DO_TEMACS, DO_XEMACS, TEMACS_BATCH, XEMACS_BATCH, XEMACS_BATCH_PACKAGES) to factor out duplicated stuff. Clean up handling of "HEAP_IN_DATA" (Cygwin) so it doesn't need to ignore the return value from dumping. Add .NO_PARALLEL since various aspects of building and dumping must be serialized but do not always have dependencies between them (this is impossible in some cases). Everything related to src/ now gets built in one pass in this directory by just running `make' (except the Makefiles themselves and config.h, paths.h, Emacs.ad.h, and other generated .h files). console.c: Update list of possibly valid console types. emacs.c: Rationalize the specifying and handling of the type of the first frame. This was originally prompted by a workspace in which I got GTK to compile under C++ and in the process fixed it so it could coexist with X in the same build -- hence, a combined TTY/X/MS-Windows/GTK build is now possible under Cygwin. (However, you can't simultaneously *display* more than one kind of device connection -- but getting that to work is not that difficult. Perhaps a project for a bored grad student. I (ben) would do it but don't see the use.) To make sense of this, I added new switches that can be used to specifically indicate the window system: -x [aka --use-x], -tty \[aka --use-tty], -msw [aka --use-ms-windows], -gtk [aka --use-gtk], and -gnome [aka --use-gnome, same as --use-gtk]. -nw continues as an alias for -tty. When none have been given, XEmacs checks for other parameters implying particular device types (-t -> tty, -display -> x [or should it have same treatment as DISPLAY below?]), and has ad-hoc logic afterwards: if env var DISPLAY is set, use x (or gtk? perhaps should check whether gnome is running), else MS Windows if it exsits, else TTY if it exists, else stream, and you must be running in batch mode. This also fixes an existing bug whereby compiling with no x, no mswin, no tty, when running non- interactively (e.g. to dump) I get "sorry, must have TTY support". emacs.c: Turn on Vstack_trace_on_error so that errors are debuggable even when occurring extremely early in reinitialization. emacs.c: Try to make sure that the user can see message output under Windows (i.e. it doesn't just disappear right away) regardless of when it occurs, e.g. in the middle of creating the first frame. emacs.c: Define new function `emacs-run-status', indicating whether XEmacs is noninteractive or interactive, whether raw, post-dump/pdump-load or run-temacs, whether we are dumping, whether pdump is in effect. event-stream.c: It's "mommas are fat", not "momas are fat". Fix other typo. event-stream.c: Conditionalize in_menu_callback check on HAVE_MENUBARS, because it won't exist on w/o menubar support, lisp.h: More hackery on RETURN_NOT_REACHED. Cygwin v3.2 DOES complain here if RETURN_NOT_REACHED() is blank, as it is for GCC 2.5+. So make it blank only for GCC 2.5 through 2.999999999999999. Declare Vstack_trace_on_error. profile.c: Need to include "profile.h" to fix warnings. sheap.c: Don't fatal() when need to rerun Make, just stderr_out() and exit(0). That way we can distinguish between a dumping failing expectedly (due to lack of stack space, triggering another dump) and unexpectedly, in which case, we want to stop building. (or go on, if -K is given) syntax.c, syntax.h: Use ints where they belong, and enum syntaxcode's where they belong, and fix warnings thereby. syntax.h: Fix crash caused by an edge condition in the syntax-cache macros. text.h: Spacing fixes. xmotif.h: New file, to get around shadowing warnings. EmacsManager.c, event-Xt.c, glyphs-x.c, gui-x.c, input-method-motif.c, xmmanagerp.h, xmprimitivep.h: Include xmotif.h. alloc.c: Conditionalize in_malloc on ERROR_CHECK_MALLOC. config.h.in, file-coding.h, fileio.c, getloadavg.c, select-x.c, signal.c, sysdep.c, sysfile.h, systime.h, text.c, unicode.c: Eliminate HAVE_WIN32_CODING_SYSTEMS, use WIN32_ANY instead. Replace defined (WIN32_NATIVE) || defined (CYGWIN) with WIN32_ANY. lisp.h: More futile attempts to walk and chew gum at the same time when dealing with subr's that don't return.
author ben
date Thu, 20 Feb 2003 08:19:44 +0000
parents 376386a54a3c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 XEMACS CODING STANDARDS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 Ben Wing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 Copyright (c) 1996 Ben Wing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 This file documents the coding standards used in the XEmacs source
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 code. Note that XEmacs follows the GNU coding standards, which are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 documented separately in ../man/standards.texi. This file only
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 documents standards that are not included in that document; typically
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 this consists of standards that are specifically relevant to the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 XEmacs code itself.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 First, a recap of the GNU standards:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 -- Put a space after every comma.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 -- Put a space before the parenthesis that begins a function call,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 macro call, function declaration or definition, or control
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 statement (if, while, switch, for). (DO NOT do this for macro
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 definitions; this is invalid preprocessor syntax.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 -- The brace that begins a control statement (if, while, for, switch,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 do) or a function definition should go on a line by itself.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 -- In function definitions, put the return type and all other
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 qualifiers on a line before the function name. Thus, the function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 name is always at the beginning of a line.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 -- Indentation level is two spaces. (However, the first and following
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 statements of a while/for/if/etc. block are indented four spaces
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 from the while/for/if keyword. The opening and closing braces are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 indented two spaces.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 -- Variable and function names should be all lowercase, with underscores
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 separating words, except for a prefixing tag, which may be in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 uppercase. Do not use the mixed-case convention (e.g.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 SetVariableToValue ()) and *especially* do not use Microsoft
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 Hungarian notation (char **rgszRedundantTag).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 -- preprocessor and enum constants should be all uppercase, and should
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 be prefixed with a tag that groups related constants together.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 Now, the XEmacs coding standards:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 **** Specially-prefixed functions/variables:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 -- All global C variables whose value is constant and is a symbol begin
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 with a capital Q, e.g. Qkey_press_event. (The type will always be
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 Lisp_Object.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 -- All other global C variables whose value is a Lisp_Object (this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 includes variables that forward into Lisp variables plus others like
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 Vselected_console) begin with a capital V.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 -- No C variables whose value is other than a Lisp_Object should begin
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 with a capital V. (This includes C variables that forward into
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 integer or boolean Lisp variables.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 -- All global C variables whose value is a struct Lisp_Subr begin with a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 capital S. (This only occurs in connection with DEFUN ()).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 -- All C functions that are Lisp primitives begin with a capital F,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 and no others should begin this way.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 **** Functions for manipulating Lisp types:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 -- Any function that creates an empty or mostly empty Lisp object
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 should begin allocate_(). (*Not* make_().) (Except, of course,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 for Lisp primitives, which usually begin Fmake_()).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 -- Any function that converts a pointer into an equivalent Lisp_Object
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 should begin make_().
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 -- Any function that converts a Lisp_Object into its equivalent pointer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 and checks the type and validity of the object (e.g. making sure
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 it's not dead) should begin decode_().
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 -- Any function that looks up a Lisp object (e.g. buffer, face) given
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 a symbol or string should begin get_(). (Except, of course, for
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 Lisp primitives, which usually begin Fget_()).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 **** Other:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 -- Any header-file declarations of the sort
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 struct foobar;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 go into the "types" section of lisp.h.