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