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