Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r74966 - trunk/libs/filesystem/v3/doc
From: bdawes_at_[hidden]
Date: 2011-10-16 08:49:13

Next message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r74967 - trunk/libs/filesystem/v3/doc"
Previous message: john_at_[hidden]: "[Boost-commit] svn:boost r74965 - in trunk/libs/regex/doc: . html html/boost_regex/background_information html/boost_regex/ref"

Author: bemandawes
Date: 2011-10-16 08:49:12 EDT (Sun, 16 Oct 2011)
New Revision: 74966
URL: http://svn.boost.org/trac/boost/changeset/74966

Log:
file_status docs work-in-progress
Text files modified:
trunk/libs/filesystem/v3/doc/reference.html | 218 ++++++++++++++++++++++++++++-----------
1 files changed, 156 insertions(+), 62 deletions(-)

Modified: trunk/libs/filesystem/v3/doc/reference.html
==============================================================================
--- trunk/libs/filesystem/v3/doc/reference.html (original)
+++ trunk/libs/filesystem/v3/doc/reference.html 2011-10-16 08:49:12 EDT (Sun, 16 Oct 2011)
@@ -59,46 +59,52 @@
 <a href="#Definitions">Definitions</a> 
 <a href="#Conformance">Conformance</a> 
 <a href="#Header-filesystem-synopsis">
- Header <boost/filesystem.hpp> synopsis</a> 
+ Header <code><boost/filesystem.hpp></code> synopsis</a> 
 <a href="#Error-reporting">Error reporting</a> 
- Class path 
-     path constructors 
-    path assignments 
-    path appends 
-    path modifiers 
-    <a href="#path-native-format-observers">path native
+ Class path 
+     path constructors 
+    path assignments 
+    path appends 
+    path modifiers 
+    <a href="#path-native-format-observers"><code>path</code> native
 format observers</a> 
-    <a href="#path-generic-format-observers">path generic
+    <a href="#path-generic-format-observers"><code>path</code> generic
 format observers</a> 
-    path decomposition 
-    path query 
-    path iterators 
-    path deprecated functions 
-    path non-member functions 
-    path inserters and extractors 
-  Class filesystem_error 
-    <a href="#filesystem_error-members">filesystem_error
+    path decomposition 
+    path query 
+    path iterators 
+    path deprecated functions 
+    path non-member functions 
+    path inserters and extractors 
+  Class filesystem_error 
+    <a href="#filesystem_error-members"><code>filesystem_error</code>
 constructors</a> 
-    filesystem_error path1 
-    filesystem_error path2 
-    filesystem_error what 
+    <code>f</code>ilesystem_error path1 
+    filesystem_error path2 
+    <a href="#filesystem_error-what"><code>filesystem_error</code><code>
+ </code>what</a></td>
+ <td width="33%" valign="top">
+ Enum file_type 
+ Enum perms 
 <a href="#file_status">Class
- file_status</a> 
-Class directory_entry 
+ <code>file_status</code></a> 
+   
+ <a href="#file_status">
+ <code>file_status</code></a> constructors 
+    <code>file_status-modifiers</code> observers 
+    <code>file_status-observers</code> modifiers 
+Class directory_entry 
   
-directory_entry constructors 
-    directory_entry modifiers 
-    directory_entry observers 
-Class directory_iterator 
-    <a href="#directory_iterator-members">directory_iterator
+directory_entry constructors 
+    directory_entry observers 
+    directory_entry modifiers 
+Class directory_iterator 
+    <a href="#directory_iterator-members"><code>directory_iterator</code>
 members</a> 
-Class recursive_directory_iterator 
- 
-  </td>
- <td width="33%" valign="top">
+Class recursive_directory_iterator 
 <a href="#Operational-functions">
 Operational functions</a> 
-   &nbsp absolute 
+ <code>   &nbsp absolute 
     canonical 
     copy 
     copy_directory 
@@ -112,14 +118,16 @@
   &nbsp exists 
   &nbsp equivalent 
   &nbsp file_size 
-     hard_link_count 
-     initial_path 
+     hard_link_count</code></td>
+ <td width="34%" valign="top">
+ <code>     initial_path 
   &nbsp is_directory 
   &nbsp is_empty 
   &nbsp is_other 
   &nbsp is_regular_file 
   &nbsp is_symlink 
   &nbsp last_write_time 
+     permissions 
     read_symlink 
   &nbsp remove 
   &nbsp remove_all 
@@ -131,8 +139,7 @@
   &nbsp symlink_status 
   &nbsp system_complete 
   &nbsp temp_directory_path 
-     unique_path</td>
- <td width="34%" valign="top">
+     </code> <code> unique_path</code> 
 <a href="#File-streams">File streams</a> 
<a href="#Path-decomposition-table">Path decomposition table</a> 
 <a href="#long-path-warning">Warning: Long paths on Windows and the
@@ -338,10 +345,23 @@

 class recursive_directory_iterator;

- enum <a name="file_type">file_type</a> { status_error, file_not_found, regular_file, directory_file,
- symlink_file, block_file, character_file, fifo_file, socket_file,
- type_unknown
- };
+ enum <a name="file_type" href="#Enum-file_type">file_type</a>
+ {
+ status_error, file_not_found, regular_file, directory_file,
+ symlink_file, block_file, character_file, fifo_file, socket_file,
+ type_unknown
+ };
+
+ enum perms
+ {
+ no_perms,
+ owner_read, owner_write, owner_exe, owner_all,
+ group_read, group_write, group_exe, group_all,
+ others_read, others_write, others_exe, others_all, all_all,
+ set_uid_on_exe, set_gid_on_exe, sticky_bit,
+ perms_mask, perms_not_known,
+ add_perms, remove_perms, symlink_perms
+ };

 class file_status;

@@ -1420,9 +1440,58 @@
 string.
</blockquote>
<h3><a name="Enum-file_type">Enum file_type</a></h3>
- 
+This enum specifies constants uses to identify file types.
+<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111">
+ <tr>
+ <td>Constant Name</td>
+ <td>Meaning</td>
+ </tr>
+ <tr>
+ <td><code>status_error</code></td>
+ <td>An error occurred while trying to obtain the status of the file. The
+ file simply not being found is not considered a status error.
+ </td>
+ </tr>
+ <tr>
+ <td><code>file_not_found</code></td>
+ <td>The file could not be found</td>
+ </tr>
+ <tr>
+ <td><code>regular_file</code></td>
+ <td>Regular file</td>
+ </tr>
+ <tr>
+ <td><code>directory_file</code></td>
+ <td>Directory file</td>
+ </tr>
+ <tr>
+ <td><code>symlink_file</code></td>
+ <td>Symbolic link file</td>
+ </tr>
+ <tr>
+ <td><code>block_file</code></td>
+ <td>Block special file</td>
+ </tr>
+ <tr>
+ <td><code>character_file</code></td>
+ <td>Character special file</td>
+ </tr>
+ <tr>
+ <td><code>fifo_file</code></td>
+ <td>FIFO or pipe file</td>
+ </tr>
+ <tr>
+ <td><code>socket_file</code></td>
+ <td>Socket file</td>
+ </tr>
+ <tr>
+ <td><code>type_unknown</code></td>
+ <td>The file exists, but it is of a system specific type not covered by any
+ of the above cases.</td>
+ </tr>
+</table>
<h3><a name="Enum-perms">Enum perms</a></h3>
-This <code>enum</code> specifies bitmask constants uses to identify file
+This enum specifies bitmask constants uses to identify file
permissions. The POSIX standard specifies actual values, and those values have
been adopted here because they are very familiar and ingrained for many POSIX
users. 
@@ -1521,38 +1590,63 @@
 class file_status
 {
 public:
- file_status();
- file_status(const file_status&);
- explicit file_status(file_type v=status_error);
- ~file_status();

- file_type type() const;
- void type(file_type v);
+ // constructors
+ file_status() noexcept;
+ explicit file_status(file_type ft, perms prms = perms_not_known) noexcept;
+
+ // compiler generated
+ file_status(const file_status&) noexcept;
+ file_status& operator=(const file_status&) noexcept;
+ ~file_status() noexcept;
+
+ // observers
+ file_type type() const noexcept;
+ perms permissions() const noexcept;
+
+ // modifiers
+ void type(file_type ft) noexcept;
+ void permissions(perms prms) noexcept;
 };
 } // namespace filesystem
 } // namespace boost</pre>
-An object of type <code>file_status</code> stores information about the status of a
-file. The internal form of the stored information is unspecified.
+An object of type <code>file_status</code> stores information about the type
+and permissions of a file.
+<h4 dir="ltr"><a name="file_status-constructors"><code>file_status</code>
+constructors</a></h4>
+<pre>explicit file_status() noexcept;</pre>
<blockquote>
- [Note: The class may be extended in the future to store
- additional status information. --end note]
+ Postconditions: <code>type() == status_error</code>, <code>
+ permissions() == perms_not_known</code>.
</blockquote>
-<h4>Members</h4>
-<pre>explicit file_status(file_type v=status_error);</pre>
+<pre>explicit file_status(file_type ft, perms prms = perms_not_known) noexcept;</pre>
<blockquote>
- Effects: Stores <code>v</code>.
- Throws: Nothing.
+ Postconditions: <code>type() == ft</code>, <code>permissions() ==
+ prms</code>.
</blockquote>
-<pre>file_type type() const;</pre>
+ <h4 dir="ltr"><a name="file_status-observers"><code>file_status</code>
+ observers</a></h4>
+<pre>file_type type() const noexcept;</pre>
<blockquote>
- Returns: The stored file_type.
+ Returns: The value of <code>type()</code> specified by the 
+ postconditions of the most recent call to a constructor, operator=, or
+ <code>type(file_type)</code> function.
</blockquote>
-<pre>void type(file_type v);</pre>
+<pre>perms permissions() const noexcept;</pre>
<blockquote>
- Effects: Stores <code>v</code>, replacing the previously stored
- value.
+ Returns: The value of <code>permissions()</code> specified by the 
+ postconditions of the most recent call to a constructor, operator=, or
+ <code>permissions(perms)</code> function.
+</blockquote>
+<h4 dir="ltr"><a name="file_status-modifiers"><code>file_status</code> modifiers</a></h4>
+<pre>void type(file_type ft) noexcept;</pre>
+<blockquote>
+ Postconditions: <code>type() == ft</code>.
+</blockquote>
+<pre>void permissions(perms prms) noexcept;</pre>
+<blockquote>
+ Postconditions: <code>permissions() == prms</code>.
</blockquote>
- 
<h3><a name="Class-directory_entry">Class <code>directory_entry</code></a></h3>
<div dir="ltr">
<pre> namespace boost
@@ -3460,7 +3554,7 @@

<a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>
Revised
-15 October 2011
+16 October 2011

</body>

Next message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r74967 - trunk/libs/filesystem/v3/doc"
Previous message: john_at_[hidden]: "[Boost-commit] svn:boost r74965 - in trunk/libs/regex/doc: . html html/boost_regex/background_information html/boost_regex/ref"

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