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