RPCSX/llvm
1
0
Fork 0
mirror of https://github.com/RPCSX/llvm.git synced 2024-11-25 12:50:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CodingStandards: Emphasize use of raw_ostream more.

Browse Source 
- Chris, please approve.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77010 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Daniel Dunbar 2009-07-24 23:04:51 +00:00
parent 67efc56b80
commit e8530a3d8c
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/CodingStandards.html
View File

@ -57,6 +57,7 @@
<li><a href="#ll_iostream"><tt>#include &lt;iostream&gt;</tt> is
<em>forbidden</em></a></li>
<li><a href="#ll_avoidendl">Avoid <tt>std::endl</tt></a></li>
<li><a href="#ll_raw_ostream">Use <tt>raw_ostream</tt></a</li>
</ol></li>
<li><a href="#nano">Microscopic Details</a>
@ -907,9 +908,9 @@ library. There are two problems with this:</p>
example) is allowed normally, it is just <tt>&lt;iostream&gt;</tt> that is
causing problems.</p>
<p>The preferred replacement for stream functionality is the
<tt>llvm::raw_ostream</tt> class (for writing to output streams of various
sorts) and the <tt>llvm::MemoryBuffer</tt> API (for reading in files).</p>
<p>In addition, new code should always
use <a href="#ll_raw_ostream"><tt>raw_ostream</tt></a> or
the <tt>llvm::MemoryBuffer</tt> API (for reading in files).</p>
</div>
@ -938,6 +939,26 @@ it's better to use a literal <tt>'\n'</tt>.</p>
</div>
<!-- _______________________________________________________________________ -->
<div class="doc_subsubsection">
<a name="ll_raw_ostream">Use <tt>raw_ostream</tt></a>
</div>
<div class="doc_text">
<p>LLVM includes a lightweight, simple, and efficient stream implementation
in <tt>llvm/Support/raw_ostream.h</tt> which provides all of the common features
of <tt>std::iostream</tt>. All new code should use <tt>raw_ostream</tt> instead
of <tt>iostream</tt>.</p>
<p>Unlike <tt>std::iostream</tt>, <tt>raw_ostream</tt> is not a template and can
be forward declared as <tt>class raw_ostream</tt>. Public headers should
generally not include the <tt>raw_ostream</tt> header, but use forward
declarations and constant references to <tt>raw_ostream</tt> instances.</p>
</div>
<!-- ======================================================================= -->
<div class="doc_subsection">
<a name="nano">Microscopic Details</a>