]> git.lyx.org Git - lyx.git/blobdiff - src/support/FileInfo.h
fix typo that put too many include paths for most people
[lyx.git] / src / support / FileInfo.h
index 8223c15c7d68199fbcc78ca4de6429c6198ed5f0..1237514e458b67a369597a24ad924d64fc9ecca4 100644 (file)
@@ -1,11 +1,11 @@
 // -*- C++ -*-
 /* This file is part of
  * ======================================================
- * 
+ *
  *           LyX, The Document Processor
- *        
+ *
  *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2000 The LyX Team.
+ *           Copyright 1995-2001 The LyX Team.
  *
  * ====================================================== */
 
 #include "LString.h"
 
 /** 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 : public noncopyable {
+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. */
@@ -43,52 +46,52 @@ public:
 
        /// 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;
-       
+
        /// 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(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 {
                /// test for read permission