Access To The GHC CVS Repository

X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fcoding-style.html;h=4f39cbfc53ea0fcfb9db4096c431c675e1935d1a;hb=5e2b22a5efbc9444a56346f3f93d863703dd1263;hp=2bcf715470036b7aad119b2331094b0fd564eb27;hpb=ba53144974730a4a6fecc4ec120ad25eed91848e;p=ghc-hetmet.git diff --git a/docs/coding-style.html b/docs/coding-style.html index 2bcf715..4f39cbf 100644 --- a/docs/coding-style.html +++ b/docs/coding-style.html @@ -1,8 +1,7 @@ - Access To The GHC CVS Repository - + GHC Style Guidelines for C code @@ -11,12 +10,10 @@

Comments

NB These are just suggestions. They're not set in stone. Some of -them are probably misguided. If you disagree with them, feel free to -modify this document (and make your commit message reasonably informative) -or mail someone (eg The FP-CVS mailing list or -reid-alastair@cs.yale.edu). - +them are probably misguided. If you disagree with them, feel free to +modify this document (and make your commit message reasonably +informative) or mail someone (eg. The GHC mailing list)

References

@@ -29,69 +26,78 @@ Writing Solid Code, Microsoft Press. (Highly recommended. Possibly the only Microsoft Press book that's worth reading. SimonPJ has a copy.) -

Autoconf documentation (which doesn't seem to be on the web). See also The autoconf macro archive and Cyclic Software's description -

-Indian Hill C Style and Coding Standards. +

Indian +Hill C Style and Coding Standards. -

A list of C programming style links -

A very large list of C programming links -

A list of Unix programming links -

Portability issues

+
We use ANSI C with some extensions. In particular, we use:
- enum
- ANSI style prototypes -
- #elsif, #error, #warning, ## and other cpp features +
- #elsif, #error, ## and other cpp features
-
Our POSIX policy: try to write code that only uses POSIX (IEEE -Std 1003.1) interfaces and APIs. When you include Rts.h, -POSIX_SOURCE is automatically defined for you before any -system headers are slurped in, unless you define -NON_POSIX_SOURCE prior to including Rts.h. -A good C library will use the POSIX_SOURCE define to -eliminate non-posix types and function prototypes, so the compiler -should complain if you venture outside the POSIX spec.


-
-
+

 We use the following gcc extensions (see gcc documentation):
+
 
-zero length arrays (useful as the last field of a struct)
-
inline annotations on functions (see later)
-
Labeled elements in initialisers
-
Function attributes (mostly just no_return)
-
Macro varargs (actually, we don't use them yet but I'm very tempted)
-
Alastair really likes to use C++ style comments - but
-    he'll probably regret it later.
-
other stuff I've forgotten about...
+
#warning
+
+
zero length arrays (useful as the last field of a struct)
+
+
inline annotations on functions (see later)
+
+
Labeled elements in initialisers
+
+
Function attributes (mostly just no_return and
+unused)
 
 
-Some of these gcc/ANSI features could be avoided (for example, we
+Some of these gcc/ANSI features could be avoided (for example, we
 could use __inline__ instead of inline or use the usual PROTO((...))
 trick in function prototypes) - but some of them can't be avoided
-so we don't try with the others.
+so we don't try with the others.
 
-

+Most of these features are actually part of the new C9X standard,
+so we hope to have mostly conformant code at some point in the future.
+
+

+Please don't use C++ style comments, they aren't standard C.
+
+

 char can be signed or unsigned - always say which you mean
 
-

+
 Our POSIX policy: try to write code that only uses POSIX (IEEE
+Std 1003.1) interfaces and APIs.  When you include Rts.h,
+POSIX_SOURCE is automatically defined for you before any
+system headers are slurped in, unless you define
+NON_POSIX_SOURCE prior to including Rts.h.
+A good C library will use the POSIX_SOURCE define to
+eliminate non-posix types and function prototypes, so the compiler
+should complain if you venture outside the POSIX spec.
+
+

 Some architectures have memory alignment constraints.
 Others don't have any constraints but go faster if you align things.
 These macros tell you which alignment to use
@@ -110,20 +116,19 @@ These macros tell you which alignment to use
   #define ALIGNMENT_DOUBLE 4
 
 
-

+

 Use StgInt, StgWord and StgPtr when reading/writing ints and ptrs to
 the stack or heap.  Note that, by definition, StgInt, StgWord and
 StgPtr are the same size and have the same alignment constraints
 even if sizeof(int) != sizeof(ptr) on that platform.
 
-

+

 Use StgInt8, StgInt16, etc when you need a certain minimum number of
 bits in a type.  Use int and nat when there's no particular
 constraint.  ANSI C only guarantees that ints are at least 16 bits but
-within GHC we assume they are 32 bits.  (I'm not sure if this is a
-good idea - ADR)
+within GHC we assume they are 32 bits (do we? --SDM).
 
-

+

 Use StgFloat and StgDouble for floating point values which will go
 on/have come from the stack or heap.  Note that StgFloat may be the
 same as StgDouble on some architectures (eg Alphas) and that it might
@@ -153,7 +158,7 @@ accesses and one that just imposes a performance penalty (this is most
 of them).  Perhaps have PREFERRED_ALIGNMENT and REQUIRED_ALIGMENT
 configurations?
 
-

+

 Avoid conditional code like this:
 
 @@ -193,23 +198,23 @@ cause of the problem.
 The ideas in this section are mostly aimed at this issue:
 
 
-
+

 Use assertions.  Use lots of assertions.  If you write a comment
 that says "takes a +ve number" add an assertion.  If you're casting
 an int to a nat, add an assertion.  If you're casting an int to a char,
 add an assertion.
 
-

+

 Write special debugging code to check the integrity of your data structures.
 (Most of the runtime checking code is in src/Sanity.c)
 Add extra assertions which call this code at the start and end of any
 code that operates on your data structures.
 
-

+

 When you find a hard-to-spot bug, try to think of some assertions,
 sanity checks or whatever that would have made the bug easier to find.
 
-

+

 When defining an enumeration, it's a good idea not to use 0 for normal
 values.  Instead, make 0 raise an internal error.  The idea here is to
 make it easier to detect pointer-related errors on the assumption that
@@ -224,9 +229,9 @@ typedef enum
     ...
 
 
-
 Use #warning or #error whenever you write a piece of incomplete/broken code.
+
 Use #warning or #error whenever you write a piece of incomplete/broken code.
 
-
 When testing, try to make infrequent things happen often.
+
 When testing, try to make infrequent things happen often.
      For example, make a context switch/gc/etc happen every time a 
      context switch/gc/etc can happen.  The system will run like a 
      pig but it'll catch a lot of bugs.
@@ -236,7 +241,7 @@ typedef enum
 Syntactic details
 
 
-Important: Put "redundant" braces or parens in your code.
+
Important: Put "redundant" braces or parens in your code.
 Omitting braces and parens leads to very hard to spot bugs -
 especially if you use macros (and you might have noticed that GHC does
 this a lot!)
@@ -244,12 +249,12 @@ this a lot!)
 
 In particular:
 

-
+

 Put braces round the body of for loops, while loops, if statements, etc.
 even if they "aren't needed" because it's really hard to find the resulting
 bug if you mess up.  Indent them any way you like but put them in there!
 
-

+

 When defining a macro, always put parens round args - just in case.
 For example, write:
 @@ -260,7 +265,7 @@ instead of
   #define add(x,y) x+y
 
 
-

+

 Don't define macros that expand to a list of statements.  
 You could just use braces as in:
 
@@ -320,7 +325,7 @@ A:      The usual goal is to write a macro that can be invoked as if it
         References: H&S Sec. 3.3.2 p. 45; CT&P Sec. 6.3 pp. 82-3.
 
 
-

+

 Don't even write macros that expand to 0 statements - they can mess you 
 up as well.  Use the doNothing macro instead.
 @@ -328,21 +333,21 @@ up as well.  Use the doNothing macro instead.
 
 
 
-

+

 Use inline functions instead of macros if possible - they're a lot
 less tricky to get right and don't suffer from the usual problems
 of side effects, evaluation order, multiple evaluation, etc.
 
 
-Inline functions get the naming issue right.  E.g. they
+
Inline functions get the naming issue right.  E.g. they
   can have local variables which (in an expression context)
   macros can't.
 
-
 Inline functions have call-by-value semantics whereas macros
+
 Inline functions have call-by-value semantics whereas macros
   are call-by-name.  You can be bitten by duplicated computation
   if you aren't careful.
 
-
 You can use inline functions from inside gdb if you compile with
+
 You can use inline functions from inside gdb if you compile with
   -O0 or -fkeep-inline-functions.  If you use macros, you'd better
   know what they expand to.
 
@@ -358,13 +363,13 @@ can be "polymorphic" as these examples show:
   #define min(x,y) (((x)<=(y)) ? (x) : (y))
 
 
-

+

 Inline functions should be "static inline" because:
 
-
+

 gcc will delete static inlines if not used or theyre always inlined.
 
-

+

   if they're externed, we could get conflicts between 2 copies of the 
   same function if, for some reason, gcc is unable to delete them.
   If they're static, we still get multiple copies but at least they don't conflict.
@@ -408,7 +413,7 @@ If any uses of the function remain, they will refer to the single copy
 in the library.
 
 
-

+

 This code
  int* p, q;
@@ -423,9 +428,9 @@ You could also write this:
  int *p, *q;
 
-but Alastair prefers to split the declarations.
+but it is preferrable to split the declarations.
 
-
+

 Try to use ANSI C's enum feature when defining lists of constants of
 the same type.  Among other benefits, you'll notice that gdb uses the
 name instead of its (usually inscrutable) number when printing values
@@ -475,23 +480,16 @@ instead of
     # define TYPEchar  'Y'
     # define TIMEchar  'T'
 
-ToDo: at the time of writing, we still use the former.
-
-

-Alastair likes to use stgCast instead of C syntax.  He claims
-it's easier to write and easier to grep for. YMMV.
--#define stgCast(ty,e) ((ty)(e))
-
 
-
 Please keep to 80 columns: the line has to be drawn somewhere,
+
 Please keep to 80 columns: the line has to be drawn somewhere,
 and by keeping it to 80 columns we can ensure that code looks OK on
 everyone's screen.  Long lines are hard to read, and a sign that the
 code needs to be restructured anyway.
 
-
 We don't care too much about your indentation style but, if
+
 We don't care too much about your indentation style but, if
 you're modifying a function, please try to use the same style as the
-rest of the function (or file).  
+rest of the function (or file).  If you're writing new code, a
+tab width of 4 is preferred.
 
 
 On which note:
@@ -523,7 +521,7 @@ within Hugs.  Add this to your .emacs file.
 
CVS issues
 
 
-
+

 Don't be tempted to reindent or reorganise large chunks of code - it
 generates large diffs in which it's hard to see whether anything else
 was changed.