Subject says it all. Updates conventions to be consistent with much of
the core. Unfortunately, that doesn't include 'struct Parrot_Interp'.
--Brent Dax <[EMAIL PROTECTED]>
@roles=map {"Parrot $_"} qw(embedding regexen Configure)
Early in the series, Patrick Stewart came up to us and asked how warp
drive worked. We explained some of the hypothetical principles . . .
"Nonsense," Patrick declared. "All you have to do is say, 'Engage.'"
--Star Trek: The Next Generation Technical Manual
Index: docs/pdds/pdd07_codingstd.pod
===================================================================
RCS file: /cvs/public/parrot/docs/pdds/pdd07_codingstd.pod,v
retrieving revision 1.5
diff -u -r1.5 pdd07_codingstd.pod
--- docs/pdds/pdd07_codingstd.pod 2 Apr 2002 07:08:43 -0000
1.5
+++ docs/pdds/pdd07_codingstd.pod 8 Jun 2002 00:04:50 -0000
@@ -391,7 +391,50 @@
=item *
-Variables and structure names should be all lower-case, eg C<pmc_foo>.
+Variables should be all lower-case.
+
+=item *
+
+Structures should have the following:
+
+=over 4
+
+=item *
+
+A structure definition with a name such as C<struct parrot_foo_t>.
+
+=item *
+
+A typedef of the form C<Foo>. This should I<not> be typedefed to a
pointer.
+(Note that some parts of the core are still using typedefs of the form
C<FOO>;
+we're currently working on changing that.)
+
+=item *
+
+If the typedef is to be externally visible, a second typedef of the
form
+C<Parrot_Foo> is also necessary. For virtually all structs, this
should be
+typedefed to a pointer to the struct. If the struct is to be
externally
+visible, this (and a forward declaration of the C<struct> form) should
be the o
nly
+externally visible parts.
+
+=back
+
+A typedef of a built-in C type (like C<Intval> or C<Floatval>) should
have the
+following forms:
+
+=over 4
+
+=item *
+
+A typedef of the form C<Fooval>. (Note that some parts of the core are
still using
+typedefs of the form C<FOOVAL>; we're currently working on changing
that.)
+
+=item *
+
+If the type is to be externally visible, a second typedef of the form
C<Parrot_Foo>.
+Often, the C<Fooval> form is defined in terms of the C<Parrot_Foo>
form.
+
+=back
=item *
