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