Changeset 711 for trunk/yat/utility/FileUtil.h

Timestamp:

Dec 21, 2006, 9:10:30 AM (16 years ago)

Author:

Jari Häkkinen

Message:

Fixes #1 and #80. Interface changed.

File:

• trunk/yat/utility/FileUtil.h (modified) (3 diffs)

trunk/yat/utility/FileUtil.h

@@ -38 +38 @@
 
   ///
-  /// FileUtil is useful for many common task on files.
+  /// FileUtil is a utility class for checking file/directory
+  /// existence and access permissions. FileUtil is a wrapper to
+  /// access(2) and stat(2).
   ///
   class FileUtil {
@@ -44 +46 @@
 
     ///
-    /// \brief Constructor
-    ///
-    /// \exception IO_error if underlying stat(2) call fails in other
-    /// ways than file does not exist.
+    /// \brief Constructor, copies \a path only
     ///
     explicit FileUtil(const std::string& path);
 
     ///
-    /// @brief Check file/directory permissions
+    /// \brief Check file/directory permissions
     ///
     /// Check if access permissions match \a mode. \a mode must be
-    /// given as r, w, x, or combinations of these letters.
+    /// given as r, w, x, or combinations of these letters. The check
+    /// is performed att call time.
     ///
-    /// @note Checking permissions on a non-existent file will return
-    /// the permissions for the parent directory, but only the parent
-    /// directory. If the parent directory does not exist then fail is
-    /// returned.
+    /// \note Checking permissions on a non-existent file will match
+    /// the permissions against the parent directory, but only the
+    /// parent directory. This means that when the parent directory
+    /// does not exist then fail is returned.
     ///
-    /// @return On success (all requested permissions granted), zero
+    /// \return On success (all requested permissions granted), zero
     /// is returned. On error (at least one bit in mode asked for a
     /// permission that is denied, or some other error occurred), -1
     /// is returned, and errno is set appropriately.
     ///
-    int access_rights(const std::string& path,const std::string& bits) const;
+    /// \exception Throws whatever exists() throws.
+    ///
+    int permissions(const std::string& bits) const;
 
     ///
-    /// @brief Check whether \a file exists.
+    /// \brief Check whether \a file exists.
     ///
-    /// @return True if \a file exists, false otherwise.
+    /// The check for the file is done when calling this function.
     ///
-    bool file_exists(const std::string& file) const;
+    /// \return True if \a file exists, false otherwise.
+    ///
+    /// \exception IO_error if underlying stat(2) call fails in other
+    /// ways than that file does not exist.
+    ///
+    /// \see stat(2)
+    ///
+    bool exists(void) const;
 
     ///
-    /// @brief Get path associated with the object.
+    /// \brief Get path associated with the object.
     ///
     const std::string& path(void) const;
@@ -87 +96 @@
     FileUtil(const FileUtil&);
 
-    bool no_file_;
     std::string path_;
-    struct stat stat_;
   };