another safety belt

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

diff --git a/src/support/FileInfo.h b/src/support/FileInfo.h
index db826bdb4a3f7901c5ab1536ec9a4cf54450e680..b83e0dc752a197815e6aaec482b64fe08e4b35d4 100644 (file)
--- a/src/support/FileInfo.h
+++ b/src/support/FileInfo.h
@@ -1,106 +1,107 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
- * 
- *           LyX, The Document Processor
- *        
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2000 The LyX Team.
+/**
+ * \file FileInfo.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * ====================================================== */
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS
+ */
 
 #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.
+ *
+ * Users must make sure to check fi.isOK() before any operations
+ * requiring the file to exist such as fi.isDir()
+ */
+class FileInfo : 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. */
-       explicit
-       FileInfo(string const & path, bool link = false);
+       explicit FileInfo(string const & path, bool link = false);
 
        /// File descriptor
-       explicit
-       FileInfo(int fildes);
+       explicit FileInfo(int fildes);
 
        /// Query a new file
        FileInfo & newFile(string const & path, bool link = false);
-       
+
        /// Query a new file descriptor
-        FileInfo & newFile(int fildes);
-       
+       FileInfo & newFile(int fildes);
+
        /// Returns a character describing file type (ls -F)
-       char const * typeIndicator() const;
-       
+       char typeIndicator() const;
+
        /// File protection mode
        mode_t getMode() const;
 
        /// 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;
-       
-       /// updates mode string to match suid/sgid/sticky bits
-       void setSticky(char * szString) const;
-       
+       string modeString() 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
        };
        /// Test whether the current user has a given set of permissions
-       bool access(int p);
+       bool access(int p) const;
        /// Is the file writable for the current user?
-       bool writable() { return access(FileInfo::wperm); }
+       bool writable() const { return access(FileInfo::wperm); }
        /// Is the file readable for the current user?
-       bool readable() { return access(FileInfo::rperm); }
+       bool readable() const { return access(FileInfo::rperm); }
        /// Is the file executable for the current user?
-       bool executable() { return access(FileInfo::xperm); }
+       bool executable() const { return access(FileInfo::xperm); }
        /// Does the file exist?
-       bool exist() { return access(FileInfo::eperm); }
+       bool exist() const { return access(FileInfo::eperm); }
        ///
        bool isLink() const;
        ///
@@ -118,7 +119,7 @@ public:
        ///
        int getError() const;
        ///
-       enum {
+       enum Err {
                ///
                NoErr = -1
        };
@@ -127,14 +128,15 @@ private:
        void init();
        ///
        void dostat(bool);
+
        ///
-       struct stat buf;
+       struct stat buf_;
        ///
-       int status;
+       int status_;
        ///
-       int err;
+       int err_;
        ///
-       string fname;
+       string fname_;
 };
 
 #endif