one small private fix in mathed, put noncopyable and tie into boost namespace

[lyx.git] / src / support / FileInfo.h

diff --git a/src/support/FileInfo.h b/src/support/FileInfo.h
index 69ea2a361606fb704e7a8917c15e471b0b9cf558..41063a9ba5b740c182027375b95fb002d8a83b9e 100644 (file)
--- a/src/support/FileInfo.h
+++ b/src/support/FileInfo.h
@@ -5,103 +5,111 @@
  *           LyX, The Document Processor
  *        
  *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-1999 The LyX Team.
+ *           Copyright 1995-2000 The LyX Team.
  *
- * ======================================================*/
+ * ====================================================== */
 
 #ifndef FILE_INFO_H
 #define FILE_INFO_H
 
+#ifdef __GNUG__
+#pragma interface
+#endif
+
 #include <ctime>
 
-#include <unistd.h>
 #include <sys/types.h>
 #include <sys/stat.h>
-
+#include <unistd.h>
+#include <boost/utility.hpp>
 #include "LString.h"
 
-/** Use objects of this class to get information about files. */
-class FileInfo {
+/** Use objects of this class to get information about files.
+ */
+class FileInfo : public boost::noncopyable {
 public:
        ///
        FileInfo();
-
+       
        /** Get information about file.
-       If link is true, the information is about the link itself, not
-       the file that is obtained by tracing the links. */
+           If link is true, the information is about the link itself, not
+           the file that is obtained by tracing the links. */
+       explicit
        FileInfo(string const & path, bool link = false);
 
-       ///
+       /// File descriptor
+       explicit
        FileInfo(int fildes);
 
-       ///
-       ~FileInfo();
-
-       ///
-       FileInfo& newFile(string const & path, bool link = false);
-
-       ///
-        FileInfo& newFile(int fildes);
+       /// Query a new file
+       FileInfo & newFile(string const & path, bool link = false);
+       
+       /// Query a new file descriptor
+        FileInfo & newFile(int fildes);
        
-       /// returns a character describing file type (ls -F)
+       /// Returns a character describing file type (ls -F)
        char const * typeIndicator() const;
-
-       ///
+       
+       /// File protection mode
        mode_t getMode() const;
 
-       ///
-       long getBlockSize() const;
-       
-       /// constructs standard mode string (ls style)
+       /// Constructs standard mode string (ls style)
        void modeString(char * szString) const;
        
        /// returns a letter describing a file type (ls style)
        char typeLetter() const;
        
        /// builds 'rwx' string describing file access rights
-       void flagRWX(unsigned short i, char * szString) const;
+       void flagRWX(mode_t i, char * szString) const;
        
        /// updates mode string to match suid/sgid/sticky bits
        void setSticky(char * szString) const;
-
+       
        ///
        time_t getModificationTime() const;
-
+       
        ///
        time_t getAccessTime() const;
-
+       
        ///
        time_t getStatusChangeTime() const;
-
-       ///
+       
+       /// Total file size in bytes
        off_t getSize() const;
-
-       ///
+       
+       /// Number of hard links
        nlink_t getNumberOfLinks() const;
-
-       ///
+       
+       /// User ID of owner
        uid_t getUid() const;
-       ///
+       
+       /// Group ID of owner
        gid_t getGid() const;
-       ///
+       
+       /// Is the file information correct? Did the query succeed?
        bool isOK() const;
-       ///
+       
+       /// Permission flags
        enum perm_test {
-               rperm = R_OK, // test for read permission
-               wperm = W_OK, // test for write permission
-               xperm = X_OK, // test for execute (search) permission
-               eperm = F_OK  // test for existence of file
+               /// test for read permission
+               rperm = R_OK,
+               /// test for write permission
+               wperm = W_OK,
+               /// test for execute (search) permission
+               xperm = X_OK,
+               /// test for existence of file
+               eperm = F_OK
        };
-       ///
-       bool access(int p);
-       ///
-       bool writable() { return access(FileInfo::wperm); }
-       ///
-       bool readable() { return access(FileInfo::rperm); }
-       ///
-       bool executable() { return access(FileInfo::xperm); }
-       ///
-       bool exist() { return access(FileInfo::eperm); }
+       /// Test whether the current user has a given set of permissions
+       bool access(int p) const;
+       /// Is the file writable for the current user?
+       bool writable() const { return access(FileInfo::wperm); }
+       /// Is the file readable for the current user?
+       bool readable() const { return access(FileInfo::rperm); }
+       /// Is the file executable for the current user?
+       bool executable() const { return access(FileInfo::xperm); }
+       /// Does the file exist?
+       bool exist() const { return access(FileInfo::eperm); }
        ///
        bool isLink() const;
        ///
@@ -119,7 +127,7 @@ public:
        ///
        int getError() const;
        ///
-       enum {
+       enum Err {
                ///
                NoErr = -1
        };
@@ -129,7 +137,7 @@ private:
        ///
        void dostat(bool);
        ///
-       struct stat * buf;
+       struct stat buf;
        ///
        int status;
        ///
@@ -139,4 +147,3 @@ private:
 };
 
 #endif
-