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>LLVM Coding Standards</title>
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   LLVM 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="#hl_earlyexit">Use Early Exits and 'continue' to Simplify
  45               Code</a></li>
  46           <li><a href="#hl_else_after_return">Don't use "else" after a
  47               return</a></li>
  48           <li><a href="#hl_predicateloops">Turn Predicate Loops into Predicate
  49               Functions</a></li>
  50         </ol></li>
  51       <li><a href="#micro">The Low Level Issues</a>
  52         <ol>
  53           <li><a href="#ll_assert">Assert Liberally</a></li>
  54           <li><a href="#ll_ns_std">Do not use 'using namespace std'</a></li>
  55           <li><a href="#ll_virtual_anch">Provide a virtual method anchor for
  56               classes in headers</a></li>
  57           <li><a href="#ll_end">Don't evaluate end() every time through a
  58               loop</a></li>
  59           <li><a href="#ll_iostream"><tt>#include &lt;iostream&gt;</tt> is
  60               <em>forbidden</em></a></li>
  61           <li><a href="#ll_avoidendl">Avoid <tt>std::endl</tt></a></li>
  62           <li><a href="#ll_raw_ostream">Use <tt>raw_ostream</tt></a</li>
  63         </ol></li>
  64
  65       <li><a href="#nano">Microscopic Details</a>
  66         <ol>
  67           <li><a href="#micro_spaceparen">Spaces Before Parentheses</a></li>
  68           <li><a href="#micro_preincrement">Prefer Preincrement</a></li>
  69           <li><a href="#micro_namespaceindent">Namespace Indentation</a></li>
  70           <li><a href="#micro_anonns">Anonymous Namespaces</a></li>
  71         </ol></li>
  72
  73
  74     </ol></li>
  75   <li><a href="#seealso">See Also</a></li>
  76 </ol>
  77
  78 <div class="doc_author">
  79   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
  80 </div>
  81
  82
  83 <!-- *********************************************************************** -->
  84 <div class="doc_section">
  85   <a name="introduction">Introduction</a>
  86 </div>
  87 <!-- *********************************************************************** -->
  88
  89 <div class="doc_text">
  90
  91 <p>This document attempts to describe a few coding standards that are being used
  92 in the LLVM source tree.  Although no coding standards should be regarded as
  93 absolute requirements to be followed in all instances, coding standards can be
  94 useful.</p>
  95
  96 <p>This document intentionally does not prescribe fixed standards for religious
  97 issues such as brace placement and space usage.  For issues like this, follow
  98 the golden rule:</p>
  99
 100 <blockquote>
 101
 102 <p><b><a name="goldenrule">If you are adding a significant body of source to a
 103 project, feel free to use whatever style you are most comfortable with.  If you
 104 are extending, enhancing, or bug fixing already implemented code, use the style
 105 that is already being used so that the source is uniform and easy to
 106 follow.</a></b></p>
 107
 108 </blockquote>
 109
 110 <p>The ultimate goal of these guidelines is the increase readability and
 111 maintainability of our common source base. If you have suggestions for topics to
 112 be included, please mail them to <a
 113 href="mailto:sabre@nondot.org">Chris</a>.</p>
 114
 115 </div>
 116
 117 <!-- *********************************************************************** -->
 118 <div class="doc_section">
 119   <a name="mechanicalissues">Mechanical Source Issues</a>
 120 </div>
 121 <!-- *********************************************************************** -->
 122
 123 <!-- ======================================================================= -->
 124 <div class="doc_subsection">
 125   <a name="sourceformating">Source Code Formatting</a>
 126 </div>
 127
 128 <!-- _______________________________________________________________________ -->
 129 <div class="doc_subsubsection">
 130   <a name="scf_commenting">Commenting</a>
 131 </div>
 132
 133 <div class="doc_text">
 134
 135 <p>Comments are one critical part of readability and maintainability.  Everyone
 136 knows they should comment, so should you.  When writing comments, write them as
 137 English prose, which means they should use proper capitalization, punctuation,
 138 etc.  Although we all should probably
 139 comment our code more than we do, there are a few very critical places that
 140 documentation is very useful:</p>
 141
 142 <b>File Headers</b>
 143
 144 <p>Every source file should have a header on it that describes the basic
 145 purpose of the file.  If a file does not have a header, it should not be
 146 checked into Subversion.  Most source trees will probably have a standard
 147 file header format.  The standard format for the LLVM source tree looks like
 148 this:</p>
 149
 150 <div class="doc_code">
 151 <pre>
 152 //===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===//
 153 //
 154 //                     The LLVM Compiler Infrastructure
 155 //
 156 // This file is distributed under the University of Illinois Open Source
 157 // License. See LICENSE.TXT for details.
 158 //
 159 //===----------------------------------------------------------------------===//
 160 //
 161 // This file contains the declaration of the Instruction class, which is the
 162 // base class for all of the VM instructions.
 163 //
 164 //===----------------------------------------------------------------------===//
 165 </pre>
 166 </div>
 167
 168 <p>A few things to note about this particular format:  The "<tt>-*- C++
 169 -*-</tt>" string on the first line is there to tell Emacs that the source file
 170 is a C++ file, not a C file (Emacs assumes .h files are C files by default).
 171 Note that this tag is not necessary in .cpp files.  The name of the file is also
 172 on the first line, along with a very short description of the purpose of the
 173 file.  This is important when printing out code and flipping though lots of
 174 pages.</p>
 175
 176 <p>The next section in the file is a concise note that defines the license
 177 that the file is released under.  This makes it perfectly clear what terms the
 178 source code can be distributed under and should not be modified in any way.</p>
 179
 180 <p>The main body of the description does not have to be very long in most cases.
 181 Here it's only two lines.  If an algorithm is being implemented or something
 182 tricky is going on, a reference to the paper where it is published should be
 183 included, as well as any notes or "gotchas" in the code to watch out for.</p>
 184
 185 <b>Class overviews</b>
 186
 187 <p>Classes are one fundamental part of a good object oriented design.  As such,
 188 a class definition should have a comment block that explains what the class is
 189 used for... if it's not obvious.  If it's so completely obvious your grandma
 190 could figure it out, it's probably safe to leave it out.  Naming classes
 191 something sane goes a long ways towards avoiding writing documentation.</p>
 192
 193
 194 <b>Method information</b>
 195
 196 <p>Methods defined in a class (as well as any global functions) should also be
 197 documented properly.  A quick note about what it does and a description of the
 198 borderline behaviour is all that is necessary here (unless something
 199 particularly tricky or insidious is going on).  The hope is that people can
 200 figure out how to use your interfaces without reading the code itself... that is
 201 the goal metric.</p>
 202
 203 <p>Good things to talk about here are what happens when something unexpected
 204 happens: does the method return null?  Abort?  Format your hard disk?</p>
 205
 206 </div>
 207
 208 <!-- _______________________________________________________________________ -->
 209 <div class="doc_subsubsection">
 210   <a name="scf_commentformat">Comment Formatting</a>
 211 </div>
 212
 213 <div class="doc_text">
 214
 215 <p>In general, prefer C++ style (<tt>//</tt>) comments.  They take less space,
 216 require less typing, don't have nesting problems, etc.  There are a few cases
 217 when it is useful to use C style (<tt>/* */</tt>) comments however:</p>
 218
 219 <ol>
 220   <li>When writing a C code: Obviously if you are writing C code, use C style
 221       comments.</li>
 222   <li>When writing a header file that may be <tt>#include</tt>d by a C source
 223       file.</li>
 224   <li>When writing a source file that is used by a tool that only accepts C
 225       style comments.</li>
 226 </ol>
 227
 228 <p>To comment out a large block of code, use <tt>#if 0</tt> and <tt>#endif</tt>.
 229 These nest properly and are better behaved in general than C style comments.</p>
 230
 231 </div>
 232
 233 <!-- _______________________________________________________________________ -->
 234 <div class="doc_subsubsection">
 235   <a name="scf_includes"><tt>#include</tt> Style</a>
 236 </div>
 237
 238 <div class="doc_text">
 239
 240 <p>Immediately after the <a href="#scf_commenting">header file comment</a> (and
 241 include guards if working on a header file), the <a
 242 href="#hl_dontinclude">minimal</a> list of <tt>#include</tt>s required by the
 243 file should be listed.  We prefer these <tt>#include</tt>s to be listed in this
 244 order:</p>
 245
 246 <ol>
 247   <li><a href="#mmheader">Main Module header</a></li>
 248   <li><a href="#hl_privateheaders">Local/Private Headers</a></li>
 249   <li><tt>llvm/*</tt></li>
 250   <li><tt>llvm/Analysis/*</tt></li>
 251   <li><tt>llvm/Assembly/*</tt></li>
 252   <li><tt>llvm/Bitcode/*</tt></li>
 253   <li><tt>llvm/CodeGen/*</tt></li>
 254   <li>...</li>
 255   <li><tt>Support/*</tt></li>
 256   <li><tt>Config/*</tt></li>
 257   <li>System <tt>#includes</tt></li>
 258 </ol>
 259
 260 <p>... and each category should be sorted by name.</p>
 261
 262 <p><a name="mmheader">The "Main Module Header"</a> file applies to .cpp file
 263 which implement an interface defined by a .h file.  This <tt>#include</tt>
 264 should always be included <b>first</b> regardless of where it lives on the file
 265 system.  By including a header file first in the .cpp files that implement the
 266 interfaces, we ensure that the header does not have any hidden dependencies
 267 which are not explicitly #included in the header, but should be.  It is also a
 268 form of documentation in the .cpp file to indicate where the interfaces it
 269 implements are defined.</p>
 270
 271 </div>
 272
 273 <!-- _______________________________________________________________________ -->
 274 <div class="doc_subsubsection">
 275   <a name="scf_codewidth">Source Code Width</a>
 276 </div>
 277
 278 <div class="doc_text">
 279
 280 <p>Write your code to fit within 80 columns of text.  This helps those of us who
 281 like to print out code and look at your code in an xterm without resizing
 282 it.</p>
 283
 284 <p>The longer answer is that there must be some limit to the width of the code
 285 in order to reasonably allow developers to have multiple files side-by-side in
 286 windows on a modest display.  If you are going to pick a width limit, it is
 287 somewhat arbitrary but you might as well pick something standard.  Going with
 288 90 columns (for example) instead of 80 columns wouldn't add any significant
 289 value and would be detrimental to printing out code.  Also many other projects
 290 have standardized on 80 columns, so some people have already configured their
 291 editors for it (vs something else, like 90 columns).</p>
 292
 293 <p>This is one of many contentious issues in coding standards, but is not up
 294 for debate.</p>
 295
 296 </div>
 297
 298 <!-- _______________________________________________________________________ -->
 299 <div class="doc_subsubsection">
 300   <a name="scf_spacestabs">Use Spaces Instead of Tabs</a>
 301 </div>
 302
 303 <div class="doc_text">
 304
 305 <p>In all cases, prefer spaces to tabs in source files.  People have different
 306 preferred indentation levels, and different styles of indentation that they
 307 like... this is fine.  What isn't is that different editors/viewers expand tabs
 308 out to different tab stops.  This can cause your code to look completely
 309 unreadable, and it is not worth dealing with.</p>
 310
 311 <p>As always, follow the <a href="#goldenrule">Golden Rule</a> above: follow the
 312 style of existing code if your are modifying and extending it.  If you like four
 313 spaces of indentation, <b>DO NOT</b> do that in the middle of a chunk of code
 314 with two spaces of indentation.  Also, do not reindent a whole source file: it
 315 makes for incredible diffs that are absolutely worthless.</p>
 316
 317 </div>
 318
 319 <!-- _______________________________________________________________________ -->
 320 <div class="doc_subsubsection">
 321   <a name="scf_indentation">Indent Code Consistently</a>
 322 </div>
 323
 324 <div class="doc_text">
 325
 326 <p>Okay, your first year of programming you were told that indentation is
 327 important.  If you didn't believe and internalize this then, now is the time.
 328 Just do it.</p>
 329
 330 </div>
 331
 332
 333 <!-- ======================================================================= -->
 334 <div class="doc_subsection">
 335   <a name="compilerissues">Compiler Issues</a>
 336 </div>
 337
 338
 339 <!-- _______________________________________________________________________ -->
 340 <div class="doc_subsubsection">
 341   <a name="ci_warningerrors">Treat Compiler Warnings Like Errors</a>
 342 </div>
 343
 344 <div class="doc_text">
 345
 346 <p>If your code has compiler warnings in it, something is wrong: you aren't
 347 casting values correctly, your have "questionable" constructs in your code, or
 348 you are doing something legitimately wrong.  Compiler warnings can cover up
 349 legitimate errors in output and make dealing with a translation unit
 350 difficult.</p>
 351
 352 <p>It is not possible to prevent all warnings from all compilers, nor is it
 353 desirable.  Instead, pick a standard compiler (like <tt>gcc</tt>) that provides
 354 a good thorough set of warnings, and stick to them.  At least in the case of
 355 <tt>gcc</tt>, it is possible to work around any spurious errors by changing the
 356 syntax of the code slightly.  For example, an warning that annoys me occurs when
 357 I write code like this:</p>
 358
 359 <div class="doc_code">
 360 <pre>
 361 if (V = getValue()) {
 362   ...
 363 }
 364 </pre>
 365 </div>
 366
 367 <p><tt>gcc</tt> will warn me that I probably want to use the <tt>==</tt>
 368 operator, and that I probably mistyped it.  In most cases, I haven't, and I
 369 really don't want the spurious errors.  To fix this particular problem, I
 370 rewrite the code like this:</p>
 371
 372 <div class="doc_code">
 373 <pre>
 374 if ((V = getValue())) {
 375   ...
 376 }
 377 </pre>
 378 </div>
 379
 380 <p>...which shuts <tt>gcc</tt> up.  Any <tt>gcc</tt> warning that annoys you can
 381 be fixed by massaging the code appropriately.</p>
 382
 383 <p>These are the <tt>gcc</tt> warnings that I prefer to enable: <tt>-Wall
 384 -Winline -W -Wwrite-strings -Wno-unused</tt></p>
 385
 386 </div>
 387
 388 <!-- _______________________________________________________________________ -->
 389 <div class="doc_subsubsection">
 390   <a name="ci_portable_code">Write Portable Code</a>
 391 </div>
 392
 393 <div class="doc_text">
 394
 395 <p>In almost all cases, it is possible and within reason to write completely
 396 portable code.  If there are cases where it isn't possible to write portable
 397 code, isolate it behind a well defined (and well documented) interface.</p>
 398
 399 <p>In practice, this means that you shouldn't assume much about the host
 400 compiler, including its support for "high tech" features like partial
 401 specialization of templates.  If these features are used, they should only be
 402 an implementation detail of a library which has a simple exposed API.</p>
 403
 404 </div>
 405
 406 <!-- _______________________________________________________________________ -->
 407 <div class="doc_subsubsection">
 408 <a name="ci_class_struct">Use of <tt>class</tt> and <tt>struct</tt> Keywords</a>
 409 </div>
 410 <div class="doc_text">
 411
 412 <p>In C++, the <tt>class</tt> and <tt>struct</tt> keywords can be used almost
 413 interchangeably. The only difference is when they are used to declare a class:
 414 <tt>class</tt> makes all members private by default while <tt>struct</tt> makes
 415 all members public by default.</p>
 416
 417 <p>Unfortunately, not all compilers follow the rules and some will generate
 418 different symbols based on whether <tt>class</tt> or <tt>struct</tt> was used to
 419 declare the symbol.  This can lead to problems at link time.</p>
 420
 421 <p>So, the rule for LLVM is to always use the <tt>class</tt> keyword, unless
 422 <b>all</b> members are public and the type is a C++ "POD" type, in which case
 423 <tt>struct</tt> is allowed.</p>
 424
 425 </div>
 426
 427 <!-- *********************************************************************** -->
 428 <div class="doc_section">
 429   <a name="styleissues">Style Issues</a>
 430 </div>
 431 <!-- *********************************************************************** -->
 432
 433
 434 <!-- ======================================================================= -->
 435 <div class="doc_subsection">
 436   <a name="macro">The High Level Issues</a>
 437 </div>
 438 <!-- ======================================================================= -->
 439
 440
 441 <!-- _______________________________________________________________________ -->
 442 <div class="doc_subsubsection">
 443   <a name="hl_module">A Public Header File <b>is</b> a Module</a>
 444 </div>
 445
 446 <div class="doc_text">
 447
 448 <p>C++ doesn't do too well in the modularity department.  There is no real
 449 encapsulation or data hiding (unless you use expensive protocol classes), but it
 450 is what we have to work with.  When you write a public header file (in the LLVM
 451 source tree, they live in the top level "include" directory), you are defining a
 452 module of functionality.</p>
 453
 454 <p>Ideally, modules should be completely independent of each other, and their
 455 header files should only include the absolute minimum number of headers
 456 possible. A module is not just a class, a function, or a namespace: <a
 457 href="http://www.cuj.com/articles/2000/0002/0002c/0002c.htm">it's a collection
 458 of these</a> that defines an interface.  This interface may be several
 459 functions, classes or data structures, but the important issue is how they work
 460 together.</p>
 461
 462 <p>In general, a module should be implemented with one or more <tt>.cpp</tt>
 463 files.  Each of these <tt>.cpp</tt> files should include the header that defines
 464 their interface first.  This ensure that all of the dependences of the module
 465 header have been properly added to the module header itself, and are not
 466 implicit.  System headers should be included after user headers for a
 467 translation unit.</p>
 468
 469 </div>
 470
 471 <!-- _______________________________________________________________________ -->
 472 <div class="doc_subsubsection">
 473   <a name="hl_dontinclude"><tt>#include</tt> as Little as Possible</a>
 474 </div>
 475
 476 <div class="doc_text">
 477
 478 <p><tt>#include</tt> hurts compile time performance.  Don't do it unless you
 479 have to, especially in header files.</p>
 480
 481 <p>But wait, sometimes you need to have the definition of a class to use it, or
 482 to inherit from it.  In these cases go ahead and <tt>#include</tt> that header
 483 file.  Be aware however that there are many cases where you don't need to have
 484 the full definition of a class.  If you are using a pointer or reference to a
 485 class, you don't need the header file.  If you are simply returning a class
 486 instance from a prototyped function or method, you don't need it.  In fact, for
 487 most cases, you simply don't need the definition of a class... and not
 488 <tt>#include</tt>'ing speeds up compilation.</p>
 489
 490 <p>It is easy to try to go too overboard on this recommendation, however.  You
 491 <b>must</b> include all of the header files that you are using -- you can
 492 include them either directly
 493 or indirectly (through another header file).  To make sure that you don't
 494 accidentally forget to include a header file in your module header, make sure to
 495 include your module header <b>first</b> in the implementation file (as mentioned
 496 above).  This way there won't be any hidden dependencies that you'll find out
 497 about later...</p>
 498
 499 </div>
 500
 501 <!-- _______________________________________________________________________ -->
 502 <div class="doc_subsubsection">
 503   <a name="hl_privateheaders">Keep "internal" Headers Private</a>
 504 </div>
 505
 506 <div class="doc_text">
 507
 508 <p>Many modules have a complex implementation that causes them to use more than
 509 one implementation (<tt>.cpp</tt>) file.  It is often tempting to put the
 510 internal communication interface (helper classes, extra functions, etc) in the
 511 public module header file.  Don't do this.</p>
 512
 513 <p>If you really need to do something like this, put a private header file in
 514 the same directory as the source files, and include it locally.  This ensures
 515 that your private interface remains private and undisturbed by outsiders.</p>
 516
 517 <p>Note however, that it's okay to put extra implementation methods a public
 518 class itself... just make them private (or protected), and all is well.</p>
 519
 520 </div>
 521
 522 <!-- _______________________________________________________________________ -->
 523 <div class="doc_subsubsection">
 524   <a name="hl_earlyexit">Use Early Exits and 'continue' to Simplify Code</a>
 525 </div>
 526
 527 <div class="doc_text">
 528
 529 <p>When reading code, keep in mind how much state and how many previous
 530 decisions have to be remembered by the reader to understand a block of code.
 531 Aim to reduce indentation where possible when it doesn't make it more difficult
 532 to understand the code.  One great way to do this is by making use of early
 533 exits and the 'continue' keyword in long loops.  As an example of using an early
 534 exit from a function, consider this "bad" code:</p>
 535
 536 <div class="doc_code">
 537 <pre>
 538 Value *DoSomething(Instruction *I) {
 539   if (!isa&lt;TerminatorInst&gt;(I) &amp;&amp;
 540       I-&gt;hasOneUse() &amp;&amp; SomeOtherThing(I)) {
 541     ... some long code ....
 542   }
 543
 544   return 0;
 545 }
 546 </pre>
 547 </div>
 548
 549 <p>This code has several problems if the body of the 'if' is large.  When you're
 550 looking at the top of the function, it isn't immediately clear that this
 551 <em>only</em> does interesting things with non-terminator instructions, and only
 552 applies to things with the other predicates.  Second, it is relatively difficult
 553 to describe (in comments) why these predicates are important because the if
 554 statement makes it difficult to lay out the comments.  Third, when you're deep
 555 within the body of the code, it is indented an extra level.   Finally, when
 556 reading the top of the function, it isn't clear what the result is if the
 557 predicate isn't true, you have to read to the end of the function to know that
 558 it returns null.</p>
 559
 560 <p>It is much preferred to format the code like this:</p>
 561
 562 <div class="doc_code">
 563 <pre>
 564 Value *DoSomething(Instruction *I) {
 565   // Terminators never need 'something' done to them because, ...
 566   if (isa&lt;TerminatorInst&gt;(I))
 567     return 0;
 568
 569   // We conservatively avoid transforming instructions with multiple uses
 570   // because goats like cheese.
 571   if (!I-&gt;hasOneUse())
 572     return 0;
 573
 574   // This is really just here for example.
 575   if (!SomeOtherThing(I))
 576     return 0;
 577
 578   ... some long code ....
 579 }
 580 </pre>
 581 </div>
 582
 583 <p>This fixes these problems.  A similar problem frequently happens in for
 584 loops.  A silly example is something like this:</p>
 585
 586 <div class="doc_code">
 587 <pre>
 588   for (BasicBlock::iterator II = BB-&gt;begin(), E = BB-&gt;end(); II != E; ++II) {
 589     if (BinaryOperator *BO = dyn_cast&lt;BinaryOperator&gt;(II)) {
 590       Value *LHS = BO-&gt;getOperand(0);
 591       Value *RHS = BO-&gt;getOperand(1);
 592       if (LHS != RHS) {
 593         ...
 594       }
 595     }
 596   }
 597 </pre>
 598 </div>
 599
 600 <p>When you have very very small loops, this sort of structure is fine, but if
 601 it exceeds more than 10-15 lines, it becomes difficult for people to read and
 602 understand at a glance.
 603 The problem with this sort of code is that it gets very nested very quickly,
 604 meaning that the reader of the code has to keep a lot of context in their brain
 605 to remember what is going immediately on in the loop, because they don't know
 606 if/when the if conditions will have elses etc.  It is strongly preferred to
 607 structure the loop like this:</p>
 608
 609 <div class="doc_code">
 610 <pre>
 611   for (BasicBlock::iterator II = BB-&gt;begin(), E = BB-&gt;end(); II != E; ++II) {
 612     BinaryOperator *BO = dyn_cast&lt;BinaryOperator&gt;(II);
 613     if (!BO) continue;
 614
 615     Value *LHS = BO-&gt;getOperand(0);
 616     Value *RHS = BO-&gt;getOperand(1);
 617     if (LHS == RHS) continue;
 618   }
 619 </pre>
 620 </div>
 621
 622 <p>This has all the benefits of using early exits from functions: it reduces
 623 nesting of the loop, it makes it easier to describe why the conditions are true,
 624 and it makes it obvious to the reader that there is no "else" coming up that
 625 they have to push context into their brain for.  If a loop is large, this can
 626 be a big understandability win.</p>
 627
 628 </div>
 629
 630 <!-- _______________________________________________________________________ -->
 631 <div class="doc_subsubsection">
 632   <a name="hl_else_after_return">Don't use "else" after a return</a>
 633 </div>
 634
 635 <div class="doc_text">
 636
 637 <p>For similar reasons above (reduction of indentation and easier reading),
 638    please do not use "else" or "else if" after something that interrupts
 639    control flow like return, break, continue, goto, etc.  For example, this is
 640    "bad":</p>
 641
 642 <div class="doc_code">
 643 <pre>
 644   case 'J': {
 645     if (Signed) {
 646       Type = Context.getsigjmp_bufType();
 647       if (Type.isNull()) {
 648         Error = ASTContext::GE_Missing_sigjmp_buf;
 649         return QualType();
 650       } else {
 651         break;
 652       }
 653     } else {
 654       Type = Context.getjmp_bufType();
 655       if (Type.isNull()) {
 656         Error = ASTContext::GE_Missing_jmp_buf;
 657         return QualType();
 658       } else {
 659         break;
 660       }
 661     }
 662   }
 663   }
 664 </pre>
 665 </div>
 666
 667 <p>It is better to write this something like:</p>
 668
 669 <div class="doc_code">
 670 <pre>
 671   case 'J':
 672     if (Signed) {
 673       Type = Context.getsigjmp_bufType();
 674       if (Type.isNull()) {
 675         Error = ASTContext::GE_Missing_sigjmp_buf;
 676         return QualType();
 677       }
 678     } else {
 679       Type = Context.getjmp_bufType();
 680       if (Type.isNull()) {
 681         Error = ASTContext::GE_Missing_jmp_buf;
 682         return QualType();
 683       }
 684     }
 685     break;
 686 </pre>
 687 </div>
 688
 689 <p>Or better yet (in this case), as:</p>
 690
 691 <div class="doc_code">
 692 <pre>
 693   case 'J':
 694     if (Signed)
 695       Type = Context.getsigjmp_bufType();
 696     else
 697       Type = Context.getjmp_bufType();
 698
 699     if (Type.isNull()) {
 700       Error = Signed ? ASTContext::GE_Missing_sigjmp_buf :
 701                        ASTContext::GE_Missing_jmp_buf;
 702       return QualType();
 703     }
 704     break;
 705 </pre>
 706 </div>
 707
 708 <p>The idea is to reduce indentation and the amount of code you have to keep
 709    track of when reading the code.</p>
 710
 711 </div>
 712
 713 <!-- _______________________________________________________________________ -->
 714 <div class="doc_subsubsection">
 715   <a name="hl_predicateloops">Turn Predicate Loops into Predicate Functions</a>
 716 </div>
 717
 718 <div class="doc_text">
 719
 720 <p>It is very common to write small loops that just compute a boolean
 721    value.  There are a number of ways that people commonly write these, but an
 722    example of this sort of thing is:</p>
 723
 724 <div class="doc_code">
 725 <pre>
 726   <b>bool FoundFoo = false;</b>
 727   for (unsigned i = 0, e = BarList.size(); i != e; ++i)
 728     if (BarList[i]-&gt;isFoo()) {
 729       <b>FoundFoo = true;</b>
 730       break;
 731     }
 732
 733   <b>if (FoundFoo) {</b>
 734     ...
 735   }
 736 </pre>
 737 </div>
 738
 739 <p>This sort of code is awkward to write, and is almost always a bad sign.
 740 Instead of this sort of loop, we strongly prefer to use a predicate function
 741 (which may be <a href="#micro_anonns">static</a>) that uses
 742 <a href="#hl_earlyexit">early exits</a> to compute the predicate.  We prefer
 743 the code to be structured like this:
 744 </p>
 745
 746
 747 <div class="doc_code">
 748 <pre>
 749 /// ListContainsFoo - Return true if the specified list has an element that is
 750 /// a foo.
 751 static bool ListContainsFoo(const std::vector&lt;Bar*&gt; &amp;List) {
 752   for (unsigned i = 0, e = List.size(); i != e; ++i)
 753     if (List[i]-&gt;isFoo())
 754       return true;
 755   return false;
 756 }
 757 ...
 758
 759   <b>if (ListContainsFoo(BarList)) {</b>
 760     ...
 761   }
 762 </pre>
 763 </div>
 764
 765 <p>There are many reasons for doing this: it reduces indentation and factors out
 766 code which can often be shared by other code that checks for the same predicate.
 767 More importantly, it <em>forces you to pick a name</em> for the function, and
 768 forces you to write a comment for it.  In this silly example, this doesn't add
 769 much value.  However, if the condition is complex, this can make it a lot easier
 770 for the reader to understand the code that queries for this predicate.  Instead
 771 of being faced with the in-line details of how we check to see if the BarList
 772 contains a foo, we can trust the function name and continue reading with better
 773 locality.</p>
 774
 775 </div>
 776
 777
 778 <!-- ======================================================================= -->
 779 <div class="doc_subsection">
 780   <a name="micro">The Low Level Issues</a>
 781 </div>
 782 <!-- ======================================================================= -->
 783
 784
 785 <!-- _______________________________________________________________________ -->
 786 <div class="doc_subsubsection">
 787   <a name="ll_assert">Assert Liberally</a>
 788 </div>
 789
 790 <div class="doc_text">
 791
 792 <p>Use the "<tt>assert</tt>" function to its fullest.  Check all of your
 793 preconditions and assumptions, you never know when a bug (not necessarily even
 794 yours) might be caught early by an assertion, which reduces debugging time
 795 dramatically.  The "<tt>&lt;cassert&gt;</tt>" header file is probably already
 796 included by the header files you are using, so it doesn't cost anything to use
 797 it.</p>
 798
 799 <p>To further assist with debugging, make sure to put some kind of error message
 800 in the assertion statement (which is printed if the assertion is tripped). This
 801 helps the poor debugging make sense of why an assertion is being made and
 802 enforced, and hopefully what to do about it.  Here is one complete example:</p>
 803
 804 <div class="doc_code">
 805 <pre>
 806 inline Value *getOperand(unsigned i) {
 807   assert(i &lt; Operands.size() &amp;&amp; "getOperand() out of range!");
 808   return Operands[i];
 809 }
 810 </pre>
 811 </div>
 812
 813 <p>Here are some examples:</p>
 814
 815 <div class="doc_code">
 816 <pre>
 817 assert(Ty-&gt;isPointerType() &amp;&amp; "Can't allocate a non pointer type!");
 818
 819 assert((Opcode == Shl || Opcode == Shr) &amp;&amp; "ShiftInst Opcode invalid!");
 820
 821 assert(idx &lt; getNumSuccessors() &amp;&amp; "Successor # out of range!");
 822
 823 assert(V1.getType() == V2.getType() &amp;&amp; "Constant types must be identical!");
 824
 825 assert(isa&lt;PHINode&gt;(Succ-&gt;front()) &amp;&amp; "Only works on PHId BBs!");
 826 </pre>
 827 </div>
 828
 829 <p>You get the idea...</p>
 830
 831 <p>Please be aware when adding assert statements that not all compilers are aware of
 832 the semantics of the assert.  In some places, asserts are used to indicate a piece of
 833 code that should not be reached.  These are typically of the form:</p>
 834
 835 <div class="doc_code">
 836 <pre>
 837 assert(0 &amp;&amp; "Some helpful error message");
 838 </pre>
 839 </div>
 840
 841 <p>When used in a function that returns a value, they should be followed with a return
 842 statement and a comment indicating that this line is never reached.  This will prevent
 843 a compiler which is unable to deduce that the assert statement never returns from
 844 generating a warning.</p>
 845
 846 <div class="doc_code">
 847 <pre>
 848 assert(0 &amp;&amp; "Some helpful error message");
 849 // Not reached
 850 return 0;
 851 </pre>
 852 </div>
 853
 854 <p>Another issue is that values used only by assertions will produce an "unused
 855  value" warning when assertions are disabled.  For example, this code will warn:
 856 </p>
 857
 858 <div class="doc_code">
 859 <pre>
 860   unsigned Size = V.size();
 861   assert(Size &gt; 42 &amp;&amp; "Vector smaller than it should be");
 862
 863   bool NewToSet = Myset.insert(Value);
 864   assert(NewToSet &amp;&amp; "The value shouldn't be in the set yet");
 865 </pre>
 866 </div>
 867
 868 <p>These are two interesting different cases: in the first case, the call to
 869 V.size() is only useful for the assert, and we don't want it executed when
 870 assertions are disabled.  Code like this should move the call into the assert
 871 itself.  In the second case, the side effects of the call must happen whether
 872 the assert is enabled or not.  In this case, the value should be cast to void
 873 to disable the warning.  To be specific, it is preferred to write the code
 874 like this:</p>
 875
 876 <div class="doc_code">
 877 <pre>
 878   assert(V.size() &gt; 42 &amp;&amp; "Vector smaller than it should be");
 879
 880   bool NewToSet = Myset.insert(Value); (void)NewToSet;
 881   assert(NewToSet &amp;&amp; "The value shouldn't be in the set yet");
 882 </pre>
 883 </div>
 884
 885
 886 </div>
 887
 888 <!-- _______________________________________________________________________ -->
 889 <div class="doc_subsubsection">
 890   <a name="ll_ns_std">Do not use '<tt>using namespace std</tt>'</a>
 891 </div>
 892
 893 <div class="doc_text">
 894 <p>In LLVM, we prefer to explicitly prefix all identifiers from the standard
 895 namespace with an "<tt>std::</tt>" prefix, rather than rely on
 896 "<tt>using namespace std;</tt>".</p>
 897
 898 <p> In header files, adding a '<tt>using namespace XXX</tt>' directive pollutes
 899 the namespace of any source file that <tt>#include</tt>s the header.  This is
 900 clearly a bad thing.</p>
 901
 902 <p>In implementation files (e.g. .cpp files), the rule is more of a stylistic
 903 rule, but is still important.  Basically, using explicit namespace prefixes
 904 makes the code <b>clearer</b>, because it is immediately obvious what facilities
 905 are being used and where they are coming from, and <b>more portable</b>, because
 906 namespace clashes cannot occur between LLVM code and other namespaces.  The
 907 portability rule is important because different standard library implementations
 908 expose different symbols (potentially ones they shouldn't), and future revisions
 909 to the C++ standard will add more symbols to the <tt>std</tt> namespace.  As
 910 such, we never use '<tt>using namespace std;</tt>' in LLVM.</p>
 911
 912 <p>The exception to the general rule (i.e. it's not an exception for
 913 the <tt>std</tt> namespace) is for implementation files.  For example, all of
 914 the code in the LLVM project implements code that lives in the 'llvm' namespace.
 915 As such, it is ok, and actually clearer, for the .cpp files to have a '<tt>using
 916 namespace llvm</tt>' directive at their top, after the <tt>#include</tt>s.  The
 917 general form of this rule is that any .cpp file that implements code in any
 918 namespace may use that namespace (and its parents'), but should not use any
 919 others.</p>
 920
 921 </div>
 922
 923 <!-- _______________________________________________________________________ -->
 924 <div class="doc_subsubsection">
 925   <a name="ll_virtual_anch">Provide a virtual method anchor for classes
 926   in headers</a>
 927 </div>
 928
 929 <div class="doc_text">
 930
 931 <p>If a class is defined in a header file and has a v-table (either it has
 932 virtual methods or it derives from classes with virtual methods), it must
 933 always have at least one out-of-line virtual method in the class.  Without
 934 this, the compiler will copy the vtable and RTTI into every <tt>.o</tt> file
 935 that <tt>#include</tt>s the header, bloating <tt>.o</tt> file sizes and
 936 increasing link times.</p>
 937
 938 </div>
 939
 940 <!-- _______________________________________________________________________ -->
 941 <div class="doc_subsubsection">
 942   <a name="ll_end">Don't evaluate end() every time through a loop</a>
 943 </div>
 944
 945 <div class="doc_text">
 946
 947 <p>Because C++ doesn't have a standard "foreach" loop (though it can be emulated
 948 with macros and may be coming in C++'0x) we end up writing a lot of loops that
 949 manually iterate from begin to end on a variety of containers or through other
 950 data structures.  One common mistake is to write a loop in this style:</p>
 951
 952 <div class="doc_code">
 953 <pre>
 954   BasicBlock *BB = ...
 955   for (BasicBlock::iterator I = BB->begin(); I != <b>BB->end()</b>; ++I)
 956      ... use I ...
 957 </pre>
 958 </div>
 959
 960 <p>The problem with this construct is that it evaluates "<tt>BB->end()</tt>"
 961 every time through the loop.  Instead of writing the loop like this, we strongly
 962 prefer loops to be written so that they evaluate it once before the loop starts.
 963 A convenient way to do this is like so:</p>
 964
 965 <div class="doc_code">
 966 <pre>
 967   BasicBlock *BB = ...
 968   for (BasicBlock::iterator I = BB->begin(), E = <b>BB->end()</b>; I != E; ++I)
 969      ... use I ...
 970 </pre>
 971 </div>
 972
 973 <p>The observant may quickly point out that these two loops may have different
 974 semantics: if the container (a basic block in this case) is being mutated, then
 975 "<tt>BB->end()</tt>" may change its value every time through the loop and the
 976 second loop may not in fact be correct.  If you actually do depend on this
 977 behavior, please write the loop in the first form and add a comment indicating
 978 that you did it intentionally.</p>
 979
 980 <p>Why do we prefer the second form (when correct)?  Writing the loop in the
 981 first form has two problems: First it may be less efficient than evaluating it
 982 at the start of the loop.  In this case, the cost is probably minor: a few extra
 983 loads every time through the loop.  However, if the base expression is more
 984 complex, then the cost can rise quickly.  I've seen loops where the end
 985 expression was actually something like: "<tt>SomeMap[x]->end()</tt>" and map
 986 lookups really aren't cheap.  By writing it in the second form consistently, you
 987 eliminate the issue entirely and don't even have to think about it.</p>
 988
 989 <p>The second (even bigger) issue is that writing the loop in the first form
 990 hints to the reader that the loop is mutating the container (a fact that a
 991 comment would handily confirm!).  If you write the loop in the second form, it
 992 is immediately obvious without even looking at the body of the loop that the
 993 container isn't being modified, which makes it easier to read the code and
 994 understand what it does.</p>
 995
 996 <p>While the second form of the loop is a few extra keystrokes, we do strongly
 997 prefer it.</p>
 998
 999 </div>
1000
1001 <!-- _______________________________________________________________________ -->
1002 <div class="doc_subsubsection">
1003   <a name="ll_iostream"><tt>#include &lt;iostream&gt;</tt> is forbidden</a>
1004 </div>
1005
1006 <div class="doc_text">
1007
1008 <p>The use of <tt>#include &lt;iostream&gt;</tt> in library files is
1009 hereby <b><em>forbidden</em></b>. The primary reason for doing this is to
1010 support clients using LLVM libraries as part of larger systems. In particular,
1011 we statically link LLVM into some dynamic libraries. Even if LLVM isn't used,
1012 the static c'tors are run whenever an application start up that uses the dynamic
1013 library. There are two problems with this:</p>
1014
1015 <ol>
1016   <li>The time to run the static c'tors impacts startup time of
1017       applications&mdash;a critical time for GUI apps.</li>
1018   <li>The static c'tors cause the app to pull many extra pages of memory off the
1019       disk: both the code for the static c'tors in each <tt>.o</tt> file and the
1020       small amount of data that gets touched. In addition, touched/dirty pages
1021       put more pressure on the VM system on low-memory machines.</li>
1022 </ol>
1023
1024 <p>Note that using the other stream headers (<tt>&lt;sstream&gt;</tt> for
1025 example) is not problematic in this regard (just <tt>&lt;iostream&gt;</tt>).
1026 However, raw_ostream provides various APIs that are better performing for almost
1027 every use than std::ostream style APIs, so you should just use it for new
1028 code.</p>
1029
1030 <p><b>New code should always
1031 use <a href="#ll_raw_ostream"><tt>raw_ostream</tt></a> for writing, or
1032 the <tt>llvm::MemoryBuffer</tt> API for reading files.</b></p>
1033
1034 </div>
1035
1036
1037 <!-- _______________________________________________________________________ -->
1038 <div class="doc_subsubsection">
1039   <a name="ll_avoidendl">Avoid <tt>std::endl</tt></a>
1040 </div>
1041
1042 <div class="doc_text">
1043
1044 <p>The <tt>std::endl</tt> modifier, when used with iostreams outputs a newline
1045 to the output stream specified.  In addition to doing this, however, it also
1046 flushes the output stream.  In other words, these are equivalent:</p>
1047
1048 <div class="doc_code">
1049 <pre>
1050 std::cout &lt;&lt; std::endl;
1051 std::cout &lt;&lt; '\n' &lt;&lt; std::flush;
1052 </pre>
1053 </div>
1054
1055 <p>Most of the time, you probably have no reason to flush the output stream, so
1056 it's better to use a literal <tt>'\n'</tt>.</p>
1057
1058 </div>
1059
1060
1061 <!-- _______________________________________________________________________ -->
1062 <div class="doc_subsubsection">
1063   <a name="ll_raw_ostream">Use <tt>raw_ostream</tt></a>
1064 </div>
1065
1066 <div class="doc_text">
1067
1068 <p>LLVM includes a lightweight, simple, and efficient stream implementation
1069 in <tt>llvm/Support/raw_ostream.h</tt> which provides all of the common features
1070 of <tt>std::ostream</tt>.  All new code should use <tt>raw_ostream</tt> instead
1071 of <tt>ostream</tt>.</p>
1072
1073 <p>Unlike <tt>std::ostream</tt>, <tt>raw_ostream</tt> is not a template and can
1074 be forward declared as <tt>class raw_ostream</tt>.  Public headers should
1075 generally not include the <tt>raw_ostream</tt> header, but use forward
1076 declarations and constant references to <tt>raw_ostream</tt> instances.</p>
1077
1078 </div>
1079
1080
1081 <!-- ======================================================================= -->
1082 <div class="doc_subsection">
1083   <a name="nano">Microscopic Details</a>
1084 </div>
1085 <!-- ======================================================================= -->
1086
1087 <p>This section describes preferred low-level formatting guidelines along with
1088 reasoning on why we prefer them.</p>
1089
1090 <!-- _______________________________________________________________________ -->
1091 <div class="doc_subsubsection">
1092   <a name="micro_spaceparen">Spaces Before Parentheses</a>
1093 </div>
1094
1095 <div class="doc_text">
1096
1097 <p>We prefer to put a space before a parentheses only in control flow
1098 statements, but not in normal function call expressions and function-like
1099 macros.  For example, this is good:</p>
1100
1101 <div class="doc_code">
1102 <pre>
1103   <b>if (</b>x) ...
1104   <b>for (</b>i = 0; i != 100; ++i) ...
1105   <b>while (</b>llvm_rocks) ...
1106
1107   <b>somefunc(</b>42);
1108   <b><a href="#ll_assert">assert</a>(</b>3 != 4 &amp;&amp; "laws of math are failing me");
1109
1110   a = <b>foo(</b>42, 92) + <b>bar(</b>x);
1111   </pre>
1112 </div>
1113
1114 <p>... and this is bad:</p>
1115
1116 <div class="doc_code">
1117 <pre>
1118   <b>if(</b>x) ...
1119   <b>for(</b>i = 0; i != 100; ++i) ...
1120   <b>while(</b>llvm_rocks) ...
1121
1122   <b>somefunc (</b>42);
1123   <b><a href="#ll_assert">assert</a> (</b>3 != 4 &amp;&amp; "laws of math are failing me");
1124
1125   a = <b>foo (</b>42, 92) + <b>bar (</b>x);
1126 </pre>
1127 </div>
1128
1129 <p>The reason for doing this is not completely arbitrary.  This style makes
1130    control flow operators stand out more, and makes expressions flow better. The
1131    function call operator binds very tightly as a postfix operator.  Putting
1132    a space after a function name (as in the last example) makes it appear that
1133    the code might bind the arguments of the left-hand-side of a binary operator
1134    with the argument list of a function and the name of the right side.  More
1135    specifically, it is easy to misread the "a" example as:</p>
1136
1137 <div class="doc_code">
1138 <pre>
1139   a = foo <b>(</b>(42, 92) + bar<b>)</b> (x);
1140 </pre>
1141 </div>
1142
1143 <p>... when skimming through the code.  By avoiding a space in a function, we
1144 avoid this misinterpretation.</p>
1145
1146 </div>
1147
1148 <!-- _______________________________________________________________________ -->
1149 <div class="doc_subsubsection">
1150   <a name="micro_preincrement">Prefer Preincrement</a>
1151 </div>
1152
1153 <div class="doc_text">
1154
1155 <p>Hard fast rule: Preincrement (<tt>++X</tt>) may be no slower than
1156 postincrement (<tt>X++</tt>) and could very well be a lot faster than it.  Use
1157 preincrementation whenever possible.</p>
1158
1159 <p>The semantics of postincrement include making a copy of the value being
1160 incremented, returning it, and then preincrementing the "work value".  For
1161 primitive types, this isn't a big deal... but for iterators, it can be a huge
1162 issue (for example, some iterators contains stack and set objects in them...
1163 copying an iterator could invoke the copy ctor's of these as well).  In general,
1164 get in the habit of always using preincrement, and you won't have a problem.</p>
1165
1166 </div>
1167
1168 <!-- _______________________________________________________________________ -->
1169 <div class="doc_subsubsection">
1170   <a name="micro_namespaceindent">Namespace Indentation</a>
1171 </div>
1172
1173 <div class="doc_text">
1174
1175 <p>
1176 In general, we strive to reduce indentation where ever possible.  This is useful
1177 because we want code to <a href="#scf_codewidth">fit into 80 columns</a> without
1178 wrapping horribly, but also because it makes it easier to understand the code.
1179 Namespaces are a funny thing: they are often large, and we often desire to put
1180 lots of stuff into them (so they can be large).  Other times they are tiny,
1181 because they just hold an enum or something similar.  In order to balance this,
1182 we use different approaches for small versus large namespaces.
1183 </p>
1184
1185 <p>
1186 If a namespace definition is small and <em>easily</em> fits on a screen (say,
1187 less than 35 lines of code), then you should indent its body.  Here's an
1188 example:
1189 </p>
1190
1191 <div class="doc_code">
1192 <pre>
1193 namespace llvm {
1194   namespace X86 {
1195     /// RelocationType - An enum for the x86 relocation codes. Note that
1196     /// the terminology here doesn't follow x86 convention - word means
1197     /// 32-bit and dword means 64-bit.
1198     enum RelocationType {
1199       /// reloc_pcrel_word - PC relative relocation, add the relocated value to
1200       /// the value already in memory, after we adjust it for where the PC is.
1201       reloc_pcrel_word = 0,
1202
1203       /// reloc_picrel_word - PIC base relative relocation, add the relocated
1204       /// value to the value already in memory, after we adjust it for where the
1205       /// PIC base is.
1206       reloc_picrel_word = 1,
1207
1208       /// reloc_absolute_word, reloc_absolute_dword - Absolute relocation, just
1209       /// add the relocated value to the value already in memory.
1210       reloc_absolute_word = 2,
1211       reloc_absolute_dword = 3
1212     };
1213   }
1214 }
1215 </pre>
1216 </div>
1217
1218 <p>Since the body is small, indenting adds value because it makes it very clear
1219 where the namespace starts and ends, and it is easy to take the whole thing in
1220 in one "gulp" when reading the code.  If the blob of code in the namespace is
1221 larger (as it typically is in a header in the llvm or clang namespaces), do not
1222 indent the code, and add a comment indicating what namespace is being closed.
1223 For example:</p>
1224
1225 <div class="doc_code">
1226 <pre>
1227 namespace llvm {
1228 namespace knowledge {
1229
1230 /// Grokable - This class represents things that Smith can have an intimate
1231 /// understanding of and contains the data associated with it.
1232 class Grokable {
1233 ...
1234 public:
1235   explicit Grokable() { ... }
1236   virtual ~Grokable() = 0;
1237
1238   ...
1239
1240 };
1241
1242 } // end namespace knowledge
1243 } // end namespace llvm
1244 </pre>
1245 </div>
1246
1247 <p>Because the class is large, we don't expect that the reader can easily
1248 understand the entire concept in a glance, and the end of the file (where the
1249 namespaces end) may be a long ways away from the place they open.  As such,
1250 indenting the contents of the namespace doesn't add any value, and detracts from
1251 the readability of the class.  In these cases it is best to <em>not</em> indent
1252 the contents of the namespace.</p>
1253
1254 </div>
1255
1256 <!-- _______________________________________________________________________ -->
1257 <div class="doc_subsubsection">
1258   <a name="micro_anonns">Anonymous Namespaces</a>
1259 </div>
1260
1261 <div class="doc_text">
1262
1263 <p>After talking about namespaces in general, you may be wondering about
1264 anonymous namespaces in particular.
1265 Anonymous namespaces are a great language feature that tells the C++ compiler
1266 that the contents of the namespace are only visible within the current
1267 translation unit, allowing more aggressive optimization and eliminating the
1268 possibility of symbol name collisions.  Anonymous namespaces are to C++ as
1269 "static" is to C functions and global variables.  While "static" is available
1270 in C++, anonymous namespaces are more general: they can make entire classes
1271 private to a file.</p>
1272
1273 <p>The problem with anonymous namespaces is that they naturally want to
1274 encourage indentation of their body, and they reduce locality of reference: if
1275 you see a random function definition in a C++ file, it is easy to see if it is
1276 marked static, but seeing if it is in an anonymous namespace requires scanning
1277 a big chunk of the file.</p>
1278
1279 <p>Because of this, we have a simple guideline: make anonymous namespaces as
1280 small as possible, and only use them for class declarations.  For example, this
1281 is good:</p>
1282
1283 <div class="doc_code">
1284 <pre>
1285 <b>namespace {</b>
1286   class StringSort {
1287   ...
1288   public:
1289     StringSort(...)
1290     bool operator&lt;(const char *RHS) const;
1291   };
1292 <b>} // end anonymous namespace</b>
1293
1294 static void Helper() {
1295   ...
1296 }
1297
1298 bool StringSort::operator&lt;(const char *RHS) const {
1299   ...
1300 }
1301
1302 </pre>
1303 </div>
1304
1305 <p>This is bad:</p>
1306
1307
1308 <div class="doc_code">
1309 <pre>
1310 <b>namespace {</b>
1311 class StringSort {
1312 ...
1313 public:
1314   StringSort(...)
1315   bool operator&lt;(const char *RHS) const;
1316 };
1317
1318 void Helper() {
1319   ...
1320 }
1321
1322 bool StringSort::operator&lt;(const char *RHS) const {
1323   ...
1324 }
1325
1326 <b>} // end anonymous namespace</b>
1327
1328 </pre>
1329 </div>
1330
1331
1332 <p>This is bad specifically because if you're looking at "Helper" in the middle
1333 of a large C++ file, that you have no immediate way to tell if it is local to
1334 the file.  When it is marked static explicitly, this is immediately obvious.
1335 Also, there is no reason to enclose the definition of "operator&lt;" in the
1336 namespace just because it was declared there.
1337 </p>
1338
1339 </div>
1340
1341
1342
1343 <!-- *********************************************************************** -->
1344 <div class="doc_section">
1345   <a name="seealso">See Also</a>
1346 </div>
1347 <!-- *********************************************************************** -->
1348
1349 <div class="doc_text">
1350
1351 <p>A lot of these comments and recommendations have been culled for other
1352 sources.  Two particularly important books for our work are:</p>
1353
1354 <ol>
1355
1356 <li><a href="http://www.amazon.com/Effective-Specific-Addison-Wesley-Professional-Computing/dp/0321334876">Effective
1357 C++</a> by Scott Meyers.  Also
1358 interesting and useful are "More Effective C++" and "Effective STL" by the same
1359 author.</li>
1360
1361 <li>Large-Scale C++ Software Design by John Lakos</li>
1362
1363 </ol>
1364
1365 <p>If you get some free time, and you haven't read them: do so, you might learn
1366 something.</p>
1367
1368 </div>
1369
1370 <!-- *********************************************************************** -->
1371
1372 <hr>
1373 <address>
1374   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1375   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1376   <a href="http://validator.w3.org/check/referer"><img
1377   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1378
1379   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1380   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
1381   Last modified: $Date$
1382 </address>
1383
1384 </body>
1385 </html>