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