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