Fix grammar, eliminate double parenthesized sentence fragment.
[oota-llvm.git] / docs / CodingStandards.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <link rel="stylesheet" href="llvm.css" type="text/css">
6   <title>A Few Coding Standards</title>
7 </head>
8 <body>
9
10 <div class="doc_title">
11   A Few Coding Standards
12 </div>
13
14 <ol>
15   <li><a href="#introduction">Introduction</a></li>
16   <li><a href="#mechanicalissues">Mechanical Source Issues</a>
17     <ol>
18       <li><a href="#sourceformating">Source Code Formatting</a>
19         <ol>
20           <li><a href="#scf_commenting">Commenting</a></li>
21           <li><a href="#scf_commentformat">Comment Formatting</a></li>
22           <li><a href="#scf_includes">#include Style</a></li>
23           <li><a href="#scf_codewidth">Source Code Width</a></li>
24           <li><a href="#scf_spacestabs">Use Spaces Instead of Tabs</a></li>
25           <li><a href="#scf_indentation">Indent Code Consistently</a></li>
26         </ol></li>
27       <li><a href="#compilerissues">Compiler Issues</a>
28         <ol>
29           <li><a href="#ci_warningerrors">Treat Compiler Warnings Like
30               Errors</a></li>
31           <li><a href="#ci_portable_code">Write Portable Code</a></li>
32         </ol></li>
33     </ol></li>
34   <li><a href="#styleissues">Style Issues</a>
35     <ol>
36       <li><a href="#macro">The High Level Issues</a>
37         <ol>
38           <li><a href="#hl_module">A Public Header File <b>is</b> a
39               Module</a></li>
40           <li><a href="#hl_dontinclude">#include as Little as Possible</a></li>
41           <li><a href="#hl_privateheaders">Keep "internal" Headers
42               Private</a></li>
43         </ol></li>
44       <li><a href="#micro">The Low Level Issues</a>
45         <ol>
46           <li><a href="#hl_assert">Assert Liberally</a></li>
47           <li><a href="#hl_preincrement">Prefer Preincrement</a></li>
48           <li><a href="#hl_avoidendl">Avoid std::endl</a></li>
49           <li><a href="#hl_exploitcpp">Exploit C++ to its Fullest</a></li>
50         </ol></li>
51     </ol></li>
52   <li><a href="#seealso">See Also</a></li>
53 </ol>
54
55 <div class="doc_author">
56   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
57 </div>
58
59
60 <!-- *********************************************************************** -->
61 <div class="doc_section">
62   <a name="introduction">Introduction</a>
63 </div>
64 <!-- *********************************************************************** -->
65
66 <div class="doc_text">
67
68 <p>This document attempts to describe a few coding standards that are being used
69 in the LLVM source tree.  Although no coding standards should be regarded as
70 absolute requirements to be followed in all instances, coding standards can be
71 useful.</p>
72
73 <p>This document intentionally does not prescribe fixed standards for religious
74 issues such as brace placement and space usage.  For issues like this, follow
75 the golden rule:</p>
76
77 <blockquote>
78
79 <p><b><a name="goldenrule">If you are adding a significant body of source to a
80 project, feel free to use whatever style you are most comfortable with.  If you
81 are extending, enhancing, or bug fixing already implemented code, use the style
82 that is already being used so that the source is uniform and easy to
83 follow.</a></b></p>
84
85 </blockquote>
86
87 <p>The ultimate goal of these guidelines is the increase readability and
88 maintainability of our common source base. If you have suggestions for topics to
89 be included, please mail them to <a
90 href="mailto:sabre@nondot.org">Chris</a>.</p>
91
92 </div>
93
94 <!-- *********************************************************************** -->
95 <div class="doc_section">
96   <a name="mechanicalissues">Mechanical Source Issues</a>
97 </div>
98 <!-- *********************************************************************** -->
99
100 <!-- ======================================================================= -->
101 <div class="doc_subsection">
102   <a name="sourceformating">Source Code Formatting</a>
103 </div>
104
105 <!-- _______________________________________________________________________ -->
106 <div class="doc_subsubsection">
107   <a name="scf_commenting">Commenting</a>
108 </div>
109
110 <div class="doc_text">
111
112 <p>Comments are one critical part of readability and maintainability.  Everyone
113 knows they should comment, so should you.  :)  Although we all should probably
114 comment our code more than we do, there are a few very critical places that
115 documentation is very useful:</p>
116
117 <b>File Headers</b>
118
119 <p>Every source file should have a header on it that
120 describes the basic purpose of the file.  If a file does not have a header, it
121 should not be checked into CVS.  Most source trees will probably have a standard
122 file header format.  The standard format for the LLVM source tree looks like
123 this:</p>
124
125 <div class="doc_code">
126 <pre>
127 //===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===//
128 // 
129 //                     The LLVM Compiler Infrastructure
130 //
131 // This file was developed by the LLVM research group and is distributed under
132 // the University of Illinois Open Source License. See LICENSE.TXT for details.
133 // 
134 //===----------------------------------------------------------------------===//
135 //
136 // This file contains the declaration of the Instruction class, which is the
137 // base class for all of the VM instructions.
138 //
139 //===----------------------------------------------------------------------===//
140 </pre>
141 </div>
142
143 <p>A few things to note about this particular format:  The "<tt>-*- C++
144 -*-</tt>" string on the first line is there to tell Emacs that the source file
145 is a C++ file, not a C file (Emacs assumes .h files are C files by default).
146 Note that this tag is not necessary in .cpp files.  The name of the file is also
147 on the first line, along with a very short description of the purpose of the
148 file.  This is important when printing out code and flipping though lots of
149 pages.</p>
150
151 <p>The next section in the file is a concise note that defines the license that
152 the file is released under.  This makes it perfectly clear what terms the source
153 code can be distributed under.</p>
154
155 <p>The main body of the description does not have to be very long in most cases.
156 Here it's only two lines.  If an algorithm is being implemented or something
157 tricky is going on, a reference to the paper where it is published should be
158 included, as well as any notes or "gotchas" in the code to watch out for.</p>
159
160 <b>Class overviews</b>
161
162 <p>Classes are one fundemental part of a good object oriented design.  As such,
163 a class definition should have a comment block that explains what the class is
164 used for... if it's not obvious.  If it's so completely obvious your grandma
165 could figure it out, it's probably safe to leave it out.  Naming classes
166 something sane goes a long ways towards avoiding writing documentation. :)</p>
167
168
169 <b>Method information</b>
170
171 <p>Methods defined in a class (as well as any global functions) should also be
172 documented properly.  A quick note about what it does any a description of the
173 borderline behaviour is all that is necessary here (unless something
174 particularly tricky or insideous is going on).  The hope is that people can
175 figure out how to use your interfaces without reading the code itself... that is
176 the goal metric.</p>
177
178 <p>Good things to talk about here are what happens when something unexpected
179 happens: does the method return null?  Abort?  Format your hard disk?</p>
180
181 </div>
182
183 <!-- _______________________________________________________________________ -->
184 <div class="doc_subsubsection">
185   <a name="scf_commentformat">Comment Formatting</a>
186 </div>
187
188 <div class="doc_text">
189
190 <p>In general, prefer C++ style (<tt>//</tt>) comments.  They take less space,
191 require less typing, don't have nesting problems, etc.  There are a few cases
192 when it is useful to use C style (<tt>/* */</tt>) comments however:</p>
193
194 <ol>
195   <li>When writing a C code: Obviously if you are writing C code, use C style
196       comments.  :)</li>
197   <li>When writing a header file that may be #included by a C source file.</li>
198   <li>When writing a source file that is used by a tool that only accepts C
199       style comments.</li>
200 </ol>
201
202 <p>To comment out a large block of code, use <tt>#if 0</tt> and <tt>#endif</tt>.
203 These nest properly and are better behaved in general than C style comments.</p>
204
205 </div>
206
207 <!-- _______________________________________________________________________ -->
208 <div class="doc_subsubsection">
209   <a name="scf_includes">#include Style</a>
210 </div>
211
212 <div class="doc_text">
213
214 <p>Immediately after the <a href="#scf_commenting">header file comment</a> (and
215 include guards if working on a header file), the <a
216 href="#hl_dontinclude">minimal</a> list of <tt>#include</tt>s required by the
217 file should be listed.  We prefer these <tt>#include</tt>s to be listed in this
218 order:</p>
219
220 <ol>
221   <li><a href="#mmheader">Main Module header</a></li>
222   <li><a href="#hl_privateheaders">Local/Private Headers</a></li>
223   <li><tt>llvm/*</tt></li>
224   <li><tt>llvm/Analysis/*</tt></li>
225   <li><tt>llvm/Assembly/*</tt></li>
226   <li><tt>llvm/Bytecode/*</tt></li>
227   <li><tt>llvm/CodeGen/*</tt></li>
228   <li>...</li>
229   <li><tt>Support/*</tt></li>
230   <li><tt>Config/*</tt></li>
231   <li>System <tt>#includes</tt></li>
232 </ol>
233
234 <p>... and each catagory should be sorted by name.</p>
235
236 <p><a name="mmheader">The "Main Module Header"</a> file applies to .cpp file
237 which implement an interface defined by a .h file.  This #include should always
238 be included <b>first</b> regardless of where it lives on the file system.  By
239 including a header file first in the .cpp files that implement the interfaces,
240 we ensure that the header does not have any hidden dependencies which are not
241 explicitly #included in the header, but should be.  It is also a form of
242 documentation in the .cpp file to indicate where the interfaces it implements
243 are defined.</p>
244
245 </div>
246
247 <!-- _______________________________________________________________________ -->
248 <div class="doc_subsubsection">
249   <a name="scf_codewidth">Source Code Width</a>
250 </div>
251
252 <div class="doc_text">
253
254 <p>Write your code to fit within 80 columns of text.  This helps those of us who
255 like to print out code and look at your code in an xterm without resizing
256 it.</p>
257
258 </div>
259
260 <!-- _______________________________________________________________________ -->
261 <div class="doc_subsubsection">
262   <a name="scf_spacestabs">Use Spaces Instead of Tabs</a>
263 </div>
264
265 <div class="doc_text">
266
267 <p>In all cases, prefer spaces to tabs in source files.  People have different
268 prefered indentation levels, and different styles of indentation that they
269 like... this is fine.  What isn't is that different editors/viewers expand tabs
270 out to different tab stops.  This can cause your code to look completely
271 unreadable, and it is not worth dealing with.</p>
272
273 <p>As always, follow the <a href="#goldenrule">Golden Rule</a> above: follow the
274 style of existing code if your are modifying and extending it.  If you like four
275 spaces of indentation, <b>DO NOT</b> do that in the middle of a chunk of code
276 with two spaces of indentation.  Also, do not reindent a whole source file: it
277 makes for incredible diffs that are absolutely worthless.</p>
278
279 </div>
280
281 <!-- _______________________________________________________________________ -->
282 <div class="doc_subsubsection">
283   <a name="scf_indentation">Indent Code Consistently</a>
284 </div>
285
286 <div class="doc_text">
287
288 <p>Okay, your first year of programming you were told that indentation is
289 important.  If you didn't believe and internalize this then, now is the time.
290 Just do it.</p>
291
292 </div>
293
294
295 <!-- ======================================================================= -->
296 <div class="doc_subsection">
297   <a name="compilerissues">Compiler Issues</a>
298 </div>
299
300
301 <!-- _______________________________________________________________________ -->
302 <div class="doc_subsubsection">
303   <a name="ci_warningerrors">Treat Compiler Warnings Like Errors</a>
304 </div>
305
306 <div class="doc_text">
307
308 <p>If your code has compiler warnings in it, something is wrong: you aren't
309 casting values correctly, your have "questionable" constructs in your code, or
310 you are doing something legitimately wrong.  Compiler warnings can cover up
311 legitimate errors in output and make dealing with a translation unit
312 difficult.</p>
313
314 <p>It is not possible to prevent all warnings from all compilers, nor is it
315 desirable.  Instead, pick a standard compiler (like <tt>gcc</tt>) that provides
316 a good thorough set of warnings, and stick to them.  At least in the case of
317 <tt>gcc</tt>, it is possible to work around any spurious errors by changing the
318 syntax of the code slightly.  For example, an warning that annoys me occurs when
319 I write code like this:</p>
320
321 <div class="doc_code">
322 <pre>
323 if (V = getValue()) {
324   ...
325 }
326 </pre>
327 </div>
328
329 <p><tt>gcc</tt> will warn me that I probably want to use the <tt>==</tt>
330 operator, and that I probably mistyped it.  In most cases, I haven't, and I
331 really don't want the spurious errors.  To fix this particular problem, I
332 rewrite the code like this:</p>
333
334 <div class="doc_code">
335 <pre>
336 if ((V = getValue())) {
337   ...
338 }
339 </pre>
340 </div>
341
342 <p>...which shuts <tt>gcc</tt> up.  Any <tt>gcc</tt> warning that annoys you can
343 be fixed by massaging the code appropriately.</p>
344
345 <p>These are the <tt>gcc</tt> warnings that I prefer to enable: <tt>-Wall
346 -Winline -W -Wwrite-strings -Wno-unused</tt></p>
347
348 </div>
349
350 <!-- _______________________________________________________________________ -->
351 <div class="doc_subsubsection">
352   <a name="ci_portable_code">Write Portable Code</a>
353 </div>
354
355 <div class="doc_text">
356
357 <p>In almost all cases, it is possible and within reason to write completely
358 portable code.  If there are cases where it isn't possible to write portable
359 code, isolate it behind a well defined (and well documented) interface.</p>
360
361 <p>In practice, this means that you shouldn't assume much about the host
362 compiler, including its support for "high tech" features like partial
363 specialization of templates.  In fact, Visual C++ 6 could be an important target
364 for our work in the future, and we don't want to have to rewrite all of our code
365 to support it.</p>
366
367 </div>
368
369 <!-- *********************************************************************** -->
370 <div class="doc_section">
371   <a name="styleissues">Style Issues</a>
372 </div>
373 <!-- *********************************************************************** -->
374
375
376 <!-- ======================================================================= -->
377 <div class="doc_subsection">
378   <a name="macro">The High Level Issues</a>
379 </div>
380
381
382 <!-- _______________________________________________________________________ -->
383 <div class="doc_subsubsection">
384   <a name="hl_module">A Public Header File <b>is</b> a Module</a>
385 </div>
386
387 <div class="doc_text">
388
389 <p>C++ doesn't do too well in the modularity department.  There is no real
390 encapsulation or data hiding (unless you use expensive protocol classes), but it
391 is what we have to work with.  When you write a public header file (in the LLVM
392 source tree, they live in the top level "include" directory), you are defining a
393 module of functionality.</p>
394
395 <p>Ideally, modules should be completely independent of each other, and their
396 header files should only include the absolute minimum number of headers
397 possible. A module is not just a class, a function, or a namespace: <a
398 href="http://www.cuj.com/articles/2000/0002/0002c/0002c.htm">it's a collection
399 of these</a> that defines an interface.  This interface may be several
400 functions, classes or data structures, but the important issue is how they work
401 together.</p>
402
403 <p>In general, a module should be implemented with one or more <tt>.cpp</tt>
404 files.  Each of these <tt>.cpp</tt> files should include the header that defines
405 their interface first.  This ensure that all of the dependences of the module
406 header have been properly added to the module header itself, and are not
407 implicit.  System headers should be included after user headers for a
408 translation unit.</p>
409
410 </div>
411
412 <!-- _______________________________________________________________________ -->
413 <div class="doc_subsubsection">
414   <a name="hl_dontinclude">#include as Little as Possible</a>
415 </div>
416
417 <div class="doc_text">
418
419 <p><tt>#include</tt> hurts compile time performance.  Don't do it unless you
420 have to, especially in header files.</p>
421
422 <p>But wait, sometimes you need to have the definition of a class to use it, or
423 to inherit from it.  In these cases go ahead and #include that header file.  Be
424 aware however that there are many cases where you don't need to have the full
425 definition of a class.  If you are using a pointer or reference to a class, you
426 don't need the header file.  If you are simply returning a class instance from a
427 prototyped function or method, you don't need it.  In fact, for most cases, you
428 simply don't need the definition of a class... and not <tt>#include</tt>'ing
429 speeds up compilation.</p>
430
431 <p>It is easy to try to go too overboard on this recommendation, however.  You
432 <b>must</b> include all of the header files that you are using, either directly
433 or indirectly (through another header file).  To make sure that you don't
434 accidently forget to include a header file in your module header, make sure to
435 include your module header <b>first</b> in the implementation file (as mentioned
436 above).  This way there won't be any hidden dependencies that you'll find out
437 about later...</p>
438
439 </div>
440
441 <!-- _______________________________________________________________________ -->
442 <div class="doc_subsubsection">
443   <a name="hl_privateheaders">Keep "internal" Headers Private</a>
444 </div>
445
446 <div class="doc_text">
447
448 <p>Many modules have a complex implementation that causes them to use more than
449 one implementation (<tt>.cpp</tt>) file.  It is often tempting to put the
450 internal communication interface (helper classes, extra functions, etc) in the
451 public module header file.  Don't do this.  :)</p>
452
453 <p>If you really need to do something like this, put a private header file in
454 the same directory as the source files, and include it locally.  This ensures
455 that your private interface remains private and undisturbed by outsiders.</p>
456
457 <p>Note however, that it's okay to put extra implementation methods a public
458 class itself... just make them private (or protected), and all is well.</p>
459
460 </div>
461
462 <!-- ======================================================================= -->
463 <div class="doc_subsection">
464   <a name="micro">The Low Level Issues</a>
465 </div>
466
467
468 <!-- _______________________________________________________________________ -->
469 <div class="doc_subsubsection">
470   <a name="hl_assert">Assert Liberally</a>
471 </div>
472
473 <div class="doc_text">
474
475 <p>Use the "<tt>assert</tt>" function to its fullest.  Check all of your
476 preconditions and assumptions, you never know when a bug (not neccesarily even
477 yours) might be caught early by an assertion, which reduces debugging time
478 dramatically.  The "<tt>&lt;cassert&gt;</tt>" header file is probably already
479 included by the header files you are using, so it doesn't cost anything to use
480 it.</p>
481
482 <p>To further assist with debugging, make sure to put some kind of error message
483 in the assertion statement (which is printed if the assertion is tripped). This
484 helps the poor debugging make sense of why an assertion is being made and
485 enforced, and hopefully what to do about it.  Here is one complete example:</p>
486
487 <div class="doc_code">
488 <pre>
489 inline Value *getOperand(unsigned i) { 
490   assert(i &lt; Operands.size() &amp;&amp; "getOperand() out of range!");
491   return Operands[i]; 
492 }
493 </pre>
494 </div>
495
496 <p>Here are some examples:</p>
497
498 <div class="doc_code">
499 <pre>
500 assert(Ty-&gt;isPointerType() &amp;&amp; "Can't allocate a non pointer type!");
501
502 assert((Opcode == Shl || Opcode == Shr) &amp;&amp; "ShiftInst Opcode invalid!");
503
504 assert(idx &lt; getNumSuccessors() &amp;&amp; "Successor # out of range!");
505
506 assert(V1.getType() == V2.getType() &amp;&amp; "Constant types must be identical!");
507
508 assert(isa&lt;PHINode&gt;(Succ-&gt;front()) &amp;&amp; "Only works on PHId BBs!");
509 </pre>
510 </div>
511
512 <p>You get the idea...</p>
513
514 </div>
515
516
517 <!-- _______________________________________________________________________ -->
518 <div class="doc_subsubsection">
519   <a name="hl_preincrement">Prefer Preincrement</a>
520 </div>
521
522 <div class="doc_text">
523
524 <p>Hard fast rule: Preincrement (<tt>++X</tt>) may be no slower than
525 postincrement (<tt>X++</tt>) and could very well be a lot faster than it.  Use
526 preincrementation whenever possible.</p>
527
528 <p>The semantics of postincrement include making a copy of the value being
529 incremented, returning it, and then preincrementing the "work value".  For
530 primitive types, this isn't a big deal... but for iterators, it can be a huge
531 issue (for example, some iterators contains stack and set objects in them...
532 copying an iterator could invoke the copy ctor's of these as well).  In general,
533 get in the habit of always using preincrement, and you won't have a problem.</p>
534
535 </div>
536
537 <!-- _______________________________________________________________________ -->
538 <div class="doc_subsubsection">
539   <a name="hl_avoidendl">Avoid std::endl</a>
540 </div>
541
542 <div class="doc_text">
543
544 <p>The <tt>std::endl</tt> modifier, when used with iostreams outputs a newline
545 to the output stream specified.  In addition to doing this, however, it also
546 flushes the output stream.  In other words, these are equivalent:</p>
547
548 <div class="doc_code">
549 <pre>
550 std::cout &lt;&lt; std::endl;
551 std::cout &lt;&lt; '\n' &lt;&lt; std::flush;
552 </pre>
553 </div>
554
555 <p>Most of the time, you probably have no reason to flush the output stream, so
556 it's better to use a literal <tt>'\n'</tt>.</p>
557
558 </div>
559
560 <!-- _______________________________________________________________________ -->
561 <div class="doc_subsubsection">
562   <a name="hl_exploitcpp">Exploit C++ to its Fullest</a>
563 </div>
564
565 <div class="doc_text">
566
567 <p>C++ is a powerful language.  With a firm grasp on its capabilities, you can
568 make write effective, consise, readable and maintainable code all at the same
569 time.  By staying consistent, you reduce the amount of special cases that need
570 to be remembered.  Reducing the total number of lines of code you write is a
571 good way to avoid documentation, and avoid giving bugs a place to hide.</p>
572
573 <p>For these reasons, come to know and love the contents of your local
574 &lt;algorithm&gt; header file.  Know about &lt;functional&gt; and what it can do
575 for you.  C++ is just a tool that wants you to master it. :)</p>
576
577 </div>
578
579 <!-- *********************************************************************** -->
580 <div class="doc_section">
581   <a name="seealso">See Also</a>
582 </div>
583 <!-- *********************************************************************** -->
584
585 <div class="doc_text">
586
587 <p>A lot of these comments and recommendations have been culled for other
588 sources.  Two particularly important books for our work are:</p>
589
590 <ol>
591
592 <li><a href="http://www.aw-bc.com/catalog/academic/product/0,1144,0201310155,00.html">Effective
593 C++</a> by Scott Meyers.  There is an online version of the book (only some
594 chapters though) <a
595 href="http://www.awlonline.com/cseng/meyerscddemo/">available as well</a>.  Also
596 interesting and useful are "More Effective C++" and "Effective STL" by the same
597 author.</li>
598
599 <li><a href="http://cseng.aw.com/book/0,3828,0201633620,00.html">Large-Scale C++
600 Software Design</a> by John Lakos</li>
601
602 </ol>
603
604 <p>If you get some free time, and you haven't read them: do so, you might learn
605 something. :)</p>
606
607 </div>
608
609 <!-- *********************************************************************** -->
610
611 <hr>
612 <address>
613   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
614   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
615   <a href="http://validator.w3.org/check/referer"><img
616   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
617
618   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
619   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
620   Last modified: $Date$
621 </address>
622
623 </body>
624 </html>