Boost logo

Boost-Commit :

Date view Thread view Subject view Author view

Subject: [Boost-commit] svn:boost r63285 - in trunk: boost/filesystem/v3 libs/filesystem/v3/doc
From: bdawes_at_[hidden]
Date: 2010-06-24 11:02:32

Author: bemandawes
Date: 2010-06-24 11:02:30 EDT (Thu, 24 Jun 2010)
New Revision: 63285
URL: http://svn.boost.org/trac/boost/changeset/63285

Log:
Document path::codecvt_type arguments
Text files modified:
   trunk/boost/filesystem/v3/path.hpp | 25 -------
   trunk/libs/filesystem/v3/doc/do_list.html | 4
   trunk/libs/filesystem/v3/doc/reference.html | 129 +++++++++++++++++++++------------------
   3 files changed, 70 insertions(+), 88 deletions(-)

Modified: trunk/boost/filesystem/v3/path.hpp
==============================================================================
--- trunk/boost/filesystem/v3/path.hpp (original)
+++ trunk/boost/filesystem/v3/path.hpp 2010-06-24 11:02:30 EDT (Thu, 24 Jun 2010)
@@ -498,31 +498,6 @@
                                          // m_pos == m_path_ptr->m_pathname.size()
   }; // path::iterator
 
- ////------------------------------------------------------------------------------------//
- //// //
- //// class scoped_path_locale //
- //// //
- ////------------------------------------------------------------------------------------//
-
- //class scoped_path_locale
- //{
- //public:
- // scoped_path_locale(const std::locale & loc)
- // : m_saved_locale(loc)
- // {
- // path::imbue(loc);
- // }
-
- // ~scoped_path_locale() // never throws()
- // {
- // try { path::imbue(m_saved_locale); }
- // catch (...) {}
- // };
-
- //private:
- // std::locale m_saved_locale;
- //};
-
   //------------------------------------------------------------------------------------//
   // //
   // non-member functions //

Modified: trunk/libs/filesystem/v3/doc/do_list.html
==============================================================================
--- trunk/libs/filesystem/v3/doc/do_list.html (original)
+++ trunk/libs/filesystem/v3/doc/do_list.html 2010-06-24 11:02:30 EDT (Thu, 24 Jun 2010)
@@ -16,7 +16,7 @@
 <body>
 
 <h1>Boost Filesystem Do List<br>
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->31 May 2010<!--webbot bot="Timestamp" endspan i-checksum="15103" --></h1>
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->24 June 2010<!--webbot bot="Timestamp" endspan i-checksum="17552" --></h1>
 
 <h2>Beta 1 comments</h2>
 <ul>
@@ -86,7 +86,6 @@
   But is that really correct?</li>
   <li style="font-size: 10pt">Behavior of root_path() has been changed. Change
   needs to be propagated to trunk?</li>
- <li style="font-size: 10pt">Add docs for scoped_path_locale.</li>
   <li style="font-size: 10pt">Regenerate path decomposition table.</li>
 </ul>
 
@@ -107,7 +106,6 @@
   separator. Rationale?</li>
   <li>Provide the name check functions for more character types? Templatize?
   take a path argument?</li>
- <li style="font-size: 10pt">Add test for scoped_path_locale.</li>
   <li style="font-size: 10pt">Add codepage 936/950/etc test cases.</li>
   <li style="font-size: 10pt">Should UDT's be supported?</li>
   <li style="font-size: 10pt">Should path iteration to a separator result in:<br>

Modified: trunk/libs/filesystem/v3/doc/reference.html
==============================================================================
--- trunk/libs/filesystem/v3/doc/reference.html (original)
+++ trunk/libs/filesystem/v3/doc/reference.html 2010-06-24 11:02:30 EDT (Thu, 24 Jun 2010)
@@ -487,40 +487,46 @@
       class path
       {
       public:
- typedef <b><i>see below</i></b> value_type; // char for POSIX, wchar_t for Windows
- typedef std::basic_string&lt;value_type&gt; string_type;
- typedef path_traits::codecvt_type codecvt_type;
+ typedef <b><i>see below</i></b> value_type; // char for POSIX, wchar_t for Windows
+ typedef std::basic_string&lt;value_type&gt; string_type;
+ typedef std::codecvt&lt;wchar_t, char, std::mbstate_t&gt; codecvt_type;
 
         // constructors and destructor
         path();
         path(const path&amp; p);
 
- template &lt;class InputIterator&gt;
- path(InputIterator begin, InputIterator end);
+ template &lt;class Source&gt;
+ path(Source const&amp; source, const codecvt_type&amp; cvt=codecvt());
 
- template &lt;class Source&gt;
- path(Source const&amp; source);
+ template &lt;class InputIterator&gt;
+ path(InputIterator begin, InputIterator end, const codecvt_type&amp; cvt=codecvt());
 
        ~path();
 
         // assignments
         path&amp; operator=(const path&amp; p);
 
- template &lt;class InputIterator&gt;
- path&amp; assign(InputIterator begin, InputIterator end);
-
- template &lt;class Source&gt;
+ template &lt;class Source&gt;
           path&amp; operator=(Source const&amp; source);
 
- // appends
- path&amp; operator/=(const path&amp; p);
+ template &lt;class Source&gt;
+ path&amp; assign(Source const&amp; source, const codecvt_type&amp; cvt)
 
         template &lt;class InputIterator&gt;
- path&amp; append(InputIterator begin, InputIterator end);
+ path&amp; assign(InputIterator begin, InputIterator end, const codecvt_type&amp; cvt=codecvt());
+
+ // appends
+ path&amp; operator/=(const path&amp; p);
 
- template &lt;class Source&gt;
+ template &lt;class Source&gt;
           path&amp; operator/=(Source const&amp; source);
 
+ template &lt;class Source&gt;
+ path&amp; append(Source const&amp; source, const codecvt_type&amp; cvt);
+
+ template &lt;class InputIterator&gt;
+ path&amp; append(InputIterator begin, InputIterator end, const codecvt_type&amp; cvt=codecvt());
+
         // modifiers
         void clear();
         path&amp; make_absolute(const path&amp; base);
@@ -530,25 +536,25 @@
         void swap(path&amp; rhs);
 
         // native format observers
- const string_type&amp; native() const; // native format, encoding
- const value_type* c_str() const; // native().c_str()
+ const string_type&amp; native() const; // native format, encoding
+ const value_type* c_str() const; // native().c_str()
 
         template &lt;class String&gt;
- String string() const; // native format, uses codecvt() for encoding
+ String string(const codecvt_type&amp; cvt=codecvt()) const; // native format
 
- const string string() const; // native format, uses codecvt() for encoding
- const wstring wstring() const; // ditto
- const u16string u16string() const; // ditto
- const u32string u32string() const; // ditto
+ const string string(const codecvt_type&amp; cvt=codecvt()) const; // native format
+ const wstring wstring(const codecvt_type&amp; cvt=codecvt()) const; // ditto
+ const u16string u16string() const; // ditto
+ const u32string u32string() const; // ditto
 
         // generic format observers
         template &lt;class String&gt;
         String generic_string() const;
 
- const string generic_string() const; // generic format, uses codecvt() for encoding
- const wstring generic_wstring() const; // ditto
- const u16string generic_u16string() const; // ditto
- const u32string generic_u32string() const; // ditto
+ const string generic_string(const codecvt_type&amp; cvt=codecvt()) const; // generic format
+ const wstring generic_wstring(const codecvt_type&amp; cvt=codecvt()) const; // ditto
+ const u16string generic_u16string() const; // ditto
+ const u32string generic_u32string() const; // ditto
 
         // decomposition
         path root_name() const;
@@ -675,10 +681,10 @@
 <blockquote>
   <p><i>Postconditions:</i> <code>empty()</code>.</p>
   </blockquote>
+<pre>template &lt;class Source&gt;
+ path(Source const&amp; source, const codecvt_type&amp; cvt=codecvt());</pre>
 <pre>template &lt;class InputIterator&gt;
- path(InputIterator begin, InputIterator end);</pre>
-<pre>template &lt;class Source&gt;
- path(Source const&amp; source);</pre>
+ path(InputIterator begin, InputIterator end, const codecvt_type&amp; cvt=codecvt());</pre>
 <blockquote>
   <p><i>Effects:</i> Stores the contents [<code>begin</code>,<code>end</code>)
   or <code>source</code> in <code>pathname</code>. If the contents are in the
@@ -688,15 +694,17 @@
   performed. <i>--end note</i>]</p>
   <p>
   <i>Remarks:</i> If the value type of&nbsp; [<code>begin</code>,<code>end</code>)
- or <code>source</code> is not <code>value_type</code>, the contents are
- converted by <code>codecvt()</code>.</p>
+ or <code>source</code> is not <code>value_type</code>, conversion is performed
+ by <code>cvt</code>.</p>
 </blockquote>
 <h3> <a name="path-assignments"> <code>
 <font size="4">path</font></code> assignments</a></h3>
-<pre>template &lt;class InputIterator&gt;
- path&amp; assign(InputIterator begin, InputIterator end);</pre>
-<pre>template &lt;class Source&gt;
+<pre>template &lt;class Source&gt;
   path&amp; operator=(Source const&amp; source);</pre>
+<pre>template &lt;class Source&gt;
+ path&amp; assign(Source const&amp; source, const codecvt_type&amp; cvt);</pre>
+<pre>template &lt;class InputIterator&gt;
+ path&amp; assign(InputIterator begin, InputIterator end, const codecvt_type&amp; cvt=codecvt());</pre>
 <blockquote>
   <p><i>Effects:</i> Stores the contents [<code>begin</code>,<code>end</code>)
   or <code>source</code> in <code>pathname</code>. If the contents are in the
@@ -708,8 +716,8 @@
   <i>Returns: </i><code>*this</code></p>
   <p>
   <i>Remarks:</i> If the value type of&nbsp; [<code>begin</code>,<code>end</code>)
- or <code>source</code> is not <code>value_type</code>, the contents are
- converted by <code>codecvt()</code>.</p>
+ or <code>source</code> is not <code>value_type</code>, conversion is performed
+ by <code>cvt</code>.</p>
   </blockquote>
 <h3> <a name="path-appends"><code><font size="4"> path</font></code> appends</a></h3>
   <p>The append operations use <code>operator/=</code> to denote their semantic
@@ -740,10 +748,12 @@
   </blockquote>
   <p><i>Returns: </i><code>*this</code></p>
 </blockquote>
-<pre>template &lt;class InputIterator&gt;
- path&amp; append(InputIterator begin, InputIterator end);</pre>
-<pre>template &lt;class Source&gt;
+<pre>template &lt;class Source&gt;
   path&amp; operator/=(Source const &amp; source);</pre>
+<pre>template &lt;class Source&gt;
+ path&amp; append(Source const &amp; source, const codecvt_type&amp; cvt);</pre>
+<pre>template &lt;class InputIterator&gt;
+ path&amp; append(InputIterator begin, InputIterator end, const codecvt_type&amp; cvt=codecvt());</pre>
 <blockquote>
   <p><i>Effects:</i></p>
   <blockquote>
@@ -763,8 +773,8 @@
     performed. <i>--end note</i>]</p>
   </blockquote>
   <p><i>Remarks:</i> If the value type of&nbsp; [<code>begin</code>,<code>end</code>)
- or <code>source</code> is not <code>value_type</code>, the contents are
- converted by <code>codecvt()</code>.</p>
+ or <code>source</code> is not <code>value_type</code>, conversion is performed
+ by <code>cvt</code>.</p>
   <p><i>Returns: </i><code>*this</code></p>
   </blockquote>
   
@@ -863,22 +873,21 @@
 <p><i>Throws:</i> nothing.</p>
 </blockquote>
 <pre>template &lt;class String&gt;
-String string() const;</pre>
+String string(const codecvt_type&amp; cvt=codecvt()) const;</pre>
 <blockquote>
   <p><i>Returns:</i> <code>pathname</code>.</p>
-<p><i>Remarks:</i> If <code>pathname</code> is of a different type than <code>
-String</code>, conversion is performed using
-<code>codecvt()</code>.</p>
+<p><i>Remarks:</i> If <code>string_type</code> is a different type than <code>
+String</code>, conversion is performed by <code>cvt</code>.</p>
 </blockquote>
-<pre>const string string() const;
-const wstring wstring() const;
+<pre>const string string(const codecvt_type&amp; cvt=codecvt()) const;
+const wstring wstring(const codecvt_type&amp; cvt=codecvt()) const;
 const u16string u16string() const;
 const u32wstring u32wstring() const; </pre>
 <blockquote>
 <p><i>Returns:</i> <code>pathname</code>.</p>
-<p><i>Remarks:</i> If <code>pathname</code> is not of the same type as the
-function's return type, conversion is performed using
-<code>codecvt()</code>. If <code>pathname</code> is of the same type as the
+<p><i>Remarks:</i> If <code>string_type</code> is a different type than
+function's return type, conversion is performed by <code>cvt</code>.</p>
+<p>If <code>string_type</code> is the same type as the
 function's return type, the function is permitted to return by <code>const&amp;</code>
 rather than <code>const</code> value. [<i>Note:</i> For POSIX, this occurs for
 <code>string()</code>, for Windows, <code>wstring()</code>. <i>--end note</i>]</p>
@@ -892,22 +901,22 @@
 generic format are the same. For Windows, backslashes are converted to slashes
 <i>--end note</i>]</p>
 <pre>template &lt;class String&gt;
-String generic_string() const;</pre>
+String generic_string(const codecvt_type&amp; cvt=codecvt()) const;</pre>
 <blockquote>
   <p><i>Returns:</i> <code>pathname</code>.</p>
-<p><i>Remarks:</i> If <code>pathname</code> is of a different type than <code>
-String</code>, conversion is performed using
-<code>codecvt()</code>.</p>
+<p><i>Remarks:</i> If <code>string_type</code> is a different type than <code>
+String</code>, conversion is performed by
+<code>cvt</code>.</p>
 </blockquote>
-<pre>const string generic_string() const;
-const wstring generic_wstring() const;
+<pre>const string generic_string(const codecvt_type&amp; cvt=codecvt()) const;
+const wstring generic_wstring(const codecvt_type&amp; cvt=codecvt()) const;
 const u16string generic_u16string() const;
 const u32wstring generic_u32wstring() const; </pre>
 <blockquote>
 <p><i>Returns:</i> <code>pathname</code>.</p>
-<p><i>Remarks:</i> If <code>pathname</code> is not of the same type as the
-function's return type, conversion is performed using
-<code>codecvt()</code>. If <code>pathname</code> is of the same type as the
+<p><i>Remarks:</i>&nbsp; If <code>string_type</code> is a different type than
+function's return type, conversion is performed by <code>cvt</code>.</p>
+<p>If <code>string_type</code> is of the same type as the
 function's return type, and the generic format is the same as the native format,
 the function is permitted to return by <code>const&amp;</code> rather than <code>
 const</code> value. [<i>Note:</i> For POSIX, this occurs for <code>string()</code>.
@@ -3068,7 +3077,7 @@
 <p>Distributed under the Boost Software License, Version 1.0. See
 <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a></p>
 <p>Revised
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->20 June 2010<!--webbot bot="Timestamp" endspan i-checksum="17544" --></p>
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->24 June 2010<!--webbot bot="Timestamp" endspan i-checksum="17552" --></p>
 
 </body>
 

Date view Thread view Subject view Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk