townforge/filesystem
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Continue work on docs, including description of C++11 strategy.

Browse Source 
[SVN r79566]
This commit is contained in:
Beman Dawes 2012-07-16 18:46:18 +00:00
parent 0cf17cf1ca
commit bd2c313ec2
2 changed files with 101 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
doc/src/boost_snippets.html
View File

@ -22,7 +22,8 @@ $id frontmatter=
</tr>
</table>
<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%">
<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse"
bordercolor="#111111" bgcolor="#D7EEFF" width="100%">
<tr>
<td><a href="index.htm">Filesystem Home</a> &nbsp;&nbsp;
<a href="release_history.html">Releases</a> &nbsp;&nbsp;
@ -48,6 +49,80 @@ $id wording_prefix=
<p>This reference documentation describes components that C++ programs may use
to perform operations involving file systems, including paths, regular files,
and directories.</p>
<blockquote>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse"
bordercolor="#111111" bgcolor="#D7EEFF" width="90%">
<tr>
<td width="100%" align="center" colspan="2">
<p align="center"><b>C++11 Support</b><p align="left">This reference
documentation is written as if all compilers supported C++11. Where
possible, the implementation falls back to C++03 if a C++11 feature is not
available.</td>
</tr>
<tr>
<td width="35%" align="center">
<b>C++11 Feature</b></td>
<td width="65%" align="center">
<b>Action if not supported by compiler</b></td>
</tr>
<tr>
<td width="35%" align="left">
<code>noexcept</code></td>
<td width="65%" align="left">
Keyword omitted.</td>
</tr>
<tr>
<td width="35%" align="left">
<code>constexpr</code></td>
<td width="65%" align="left">
Keyword omitted.</td>
</tr>
<tr>
<td width="35%" align="left">
<p dir="rtl">R-value references</td>
<td width="65%" align="left">
Function signature omitted.</td>
</tr>
<tr>
<td width="35%" align="left">
New character types</td>
<td width="65%" align="left">
<p dir="ltr">The <code>boost::filesystem</code> interface doesn't use the
new types directly. It does use <code>u16string</code> and <code>u32string</code>
in namespace <code>boost</code>. These are typedefs to <code>std::u16string</code>
and <code>std::u32string</code> for C++11, or to <code>
std::basic_string&lt;boost::u16_t&gt;</code> and <code>
std::basic_string&lt;boost::u32_t&gt;</code> for C++03.</td>
</tr>
<tr>
<td width="35%" align="left">
Defaulted and deleted functions</td>
<td width="65%" align="left">
Workaround replacement functions provided.</td>
</tr>
<tr>
<td width="35%" align="left">
Initializer lists</td>
<td width="65%" align="left">
Not currently used.</td>
</tr>
<tr>
<td width="35%" align="left">
Variadic templates</td>
<td width="65%" align="left">
Not currently used.</td>
</tr>
<tr>
<td width="35%" align="left">
Range-based for statements</td>
<td width="65%" align="left">
Supporting functions always provided; they do no harm even for C++03
compilers.</td>
</tr>
</table>
</blockquote>
$endid
$id wording_suffix=
@ -115,7 +190,7 @@ $id backmatter=>
</font>
<a href="http://www.boost.org/LICENSE_1_0.txt"><font size="2">www.boost.org/LICENSE_1_0.txt</font></a></p>
<p><font size="2">Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->20 March 2012<!--webbot bot="Timestamp" endspan i-checksum="27254" --></font></p>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->16 July 2012<!--webbot bot="Timestamp" endspan i-checksum="18787" --></font></p>
$endid

43
doc/src/source.html
View File

@ -608,7 +608,8 @@ $endif; void swap(path&amp; lhs, path&amp; rhs);
system::error_code&amp; ec);
void <a href="#copy_symlink">copy_symlink</a>(const path&amp; existing_symlink, const path&amp; new_symlink);
void <a href="#copy_symlink">copy_symlink</a>(const path&amp; existing_symlink, const path&amp; new_symlink, system::error_code&amp; ec);
void <a href="#copy_symlink">copy_symlink</a>(const path&amp; existing_symlink, const path&amp; new_symlink,
system::error_code&amp; ec);
bool <a href="#create_directories">create_directories</a>(const path&amp; p);
bool <a href="#create_directories">create_directories</a>(const path&amp; p, system::error_code&amp; ec);
@ -617,13 +618,16 @@ $endif; void swap(path&amp; lhs, path&amp; rhs);
bool <a href="#create_directory">create_directory</a>(const path&amp; p, system::error_code&amp; ec);
void <a href="#create_directory_symlink">create_directory_symlink</a>(const path&amp; to, const path&amp; new_symlink);
void <a href="#create_directory_symlink">create_directory_symlink</a>(const path&amp; to, const path&amp; new_symlink, system::error_code&amp; ec);
void <a href="#create_directory_symlink">create_directory_symlink</a>(const path&amp; to, const path&amp; new_symlink,
system::error_code&amp; ec);
void <a href="#create_hard_link">create_hard_link</a>(const path&amp; to, const path&amp; new_hard_link);
void <a href="#create_hard_link">create_hard_link</a>(const path&amp; to, const path&amp; new_hard_link, system::error_code&amp; ec);
void <a href="#create_hard_link">create_hard_link</a>(const path&amp; to, const path&amp; new_hard_link,
system::error_code&amp; ec);
void <a href="#create_symlink">create_symlink</a>(const path&amp; to, const path&amp; new_symlink);
void <a href="#create_symlink">create_symlink</a>(const path&amp; to, const path&amp; new_symlink, system::error_code&amp; ec);
void <a href="#create_symlink">create_symlink</a>(const path&amp; to, const path&amp; new_symlink,
system::error_code&amp; ec);
path <a href="#current_path">current_path</a>();
path <a href="#current_path">current_path</a>(system::error_code&amp; ec);
@ -668,7 +672,8 @@ $endif; void swap(path&amp; lhs, path&amp; rhs);
std::time_t <a href="#last_write_time">last_write_time</a>(const path&amp; p);
std::time_t <a href="#last_write_time">last_write_time</a>(const path&amp; p, system::error_code&amp; ec);
void <a href="#last_write_time2">last_write_time</a>(const path&amp; p, const std::time_t new_time);
void <a href="#last_write_time2">last_write_time</a>(const path&amp; p, const std::time_t new_time, system::error_code&amp; ec);
void <a href="#last_write_time2">last_write_time</a>(const path&amp; p, const std::time_t new_time,
system::error_code&amp; ec);
path <a href="#read_symlink">read_symlink</a>(const path&amp; p);
path <a href="#read_symlink">read_symlink</a>(const path&amp; p, system::error_code&amp; ec);
@ -786,10 +791,10 @@ system or for a particular file system.</p>
template &lt;class <a href="#Source">Source</a>&gt;
path&amp; operator=(Source const&amp; source);
template &lt;class <a href="#Source">Source</a>&gt;
$if $TARGET; == BOOST template &lt;class <a href="#Source">Source</a>&gt;
path&amp; assign(Source const&amp; source$CODECVT_ARG2;)
template &lt;class <a href="#InputIterator">InputIterator</a>&gt;
$endif; template &lt;class <a href="#InputIterator">InputIterator</a>&gt;
path&amp; assign(InputIterator begin, InputIterator end$CODECVT_ARG2;$CODECVT_DEFAULT;);
// <a href="#path-appends">appends</a>
@ -798,10 +803,10 @@ system or for a particular file system.</p>
template &lt;class <a href="#Source">Source</a>&gt;
path&amp; operator/=(Source const&amp; source);
template &lt;class <a href="#Source">Source</a>&gt;
$if $TARGET; == BOOST template &lt;class <a href="#Source">Source</a>&gt;
path&amp; append(Source const&amp; source$CODECVT_ARG2;);
template &lt;class <a href="#InputIterator">InputIterator</a>&gt;
$endif; template &lt;class <a href="#InputIterator">InputIterator</a>&gt;
path&amp; append(InputIterator begin, InputIterator end$CODECVT_ARG2;$CODECVT_DEFAULT;);
// <a href="#path-concatenation">concatenation</a>
@ -813,9 +818,9 @@ system or for a particular file system.</p>
path&amp; operator+=(Source const&amp; x);
template &lt;class CharT&gt;
path&amp; operator+=(CharT x);
template &lt;class Source&gt;
$if $TARGET; == BOOST template &lt;class Source&gt;
path&amp; concat(Source const&amp; x$CODECVT_ARG2;);
template &lt;class InputIterator&gt;
$endif; template &lt;class InputIterator&gt;
path&amp; concat(InputIterator begin, InputIterator end);
template &lt;class InputIterator&gt;
path&amp; concat(InputIterator begin, InputIterator end$CODECVT_ARG2;);
@ -961,10 +966,10 @@ requirements for a C++ standard library <code>RandomIterator</code> compliant it
<h3> <a name="path-assignments"> <code>
<font size="4">path</font></code> assignments</a> [path.assign]</h3>
<pre>template &lt;class <a href="#Source">Source</a>&gt;
path&amp; operator=(Source const&amp; source);</pre>
<pre>template &lt;class <a href="#Source">Source</a>&gt;
path&amp; assign(Source const&amp; source$CODECVT_ARG2;);</pre>
<pre>template &lt;class <a href="#InputIterator">InputIterator</a>&gt;
path&amp; operator=(Source const&amp; source);
$if $TARGET; == BOOST template &lt;class <a href="#Source">Source</a>&gt;
path&amp; assign(Source const&amp; source$CODECVT_ARG2;);
$endif; template &lt;class <a href="#InputIterator">InputIterator</a>&gt;
path&amp; assign(InputIterator begin, InputIterator end$CODECVT_ARG2;$CODECVT_DEFAULT;);</pre>
<blockquote>
<p><i>Effects:</i> Stores the contents [<code>begin</code>,<code>end</code>)
@ -995,10 +1000,10 @@ requirements for a C++ standard library <code>RandomIterator</code> compliant it
<p><i>Returns: </i><code>*this</code></p>
</blockquote>
<pre>template &lt;class <a href="#Source">Source</a>&gt;
path&amp; operator/=(Source const &amp; source);</pre>
<pre>template &lt;class <a href="#Source">Source</a>&gt;
path&amp; append(Source const &amp; source$CODECVT_ARG2;);</pre>
<pre>template &lt;class <a href="#InputIterator">InputIterator</a>&gt;
path&amp; operator/=(Source const &amp; source);
$if $TARGET; == BOOST template &lt;class <a href="#Source">Source</a>&gt;
path&amp; append(Source const &amp; source$CODECVT_ARG2;);
$endif; template &lt;class <a href="#InputIterator">InputIterator</a>&gt;
path&amp; append(InputIterator begin, InputIterator end$CODECVT_ARG2;$CODECVT_DEFAULT;);</pre>
<blockquote>
<p><i>Effects:</i></p>