UT/UT_DirUtil.h

Go to the documentation of this file.

#ifndef _UT_DIRUTIL_H_
#define _UT_DIRUTIL_H_

#include "UT_API.h"
#include <time.h>

#include "UT_String.h"
#include "UT_StringArray.h"

UT_API int UTunixFullPathSpecified(const char *name);
UT_API int UTfullPathSpecified(const char *name);
UT_API int UTisValidDirectory(const char *path);
// This, unlike, UTfullPathSpecified, returns false for ./filename
UT_API bool UTisAbsolutePath(const char *filename);
UT_API bool UTisRootPath(const char *filename);
UT_API void UTmakeAbsoluteFilePath(UT_String &path, const char *basepath=NULL);
UT_API const UT_StringArray &UTgetAbsolutePathPrefixes();
UT_API void UTaddAbsolutePathPrefix(const char *prefix);

// Please pass in just the filename and not the entire path.
UT_API bool UTisHiddenFile(const char *filename);

class UT_API UT_FileStat
{
public:
    enum FileType
    {
        REGULAR,
        EXECUTABLE,
        DIRECTORY,
        SHORTCUT,       // only on Windows
        SOCKET,
        CHAR_DEVICE,
        BLOCK_DEVICE,
        SPECIAL
    };

    UT_FileStat(FileType ftype = REGULAR, int64 fsize = 0,
                time_t f_atime = 0, time_t f_ctime = 0, time_t f_mtime = 0)
        :   myFileType(ftype),
            mySize(fsize),
            myAccessTime(f_atime),
            myCreateTime(f_ctime),
            myModTime(f_mtime)
    {
    }

    FileType    myFileType;
    int64       mySize;
    time_t      myAccessTime;
    time_t      myCreateTime;
    time_t      myModTime;
};

#ifdef WIN32
    #include <sys/types.h>
    #include <direct.h>

    // Define dummy value to compare with errno in assertions related
    // to Linux libraries and large file systems.
    #define EOVERFLOW   100

    typedef intptr_t DIR;
    struct dirent {
        char *d_name;
    };
    UT_API DIR *opendir( const char *name );
    UT_API struct dirent *readdir( DIR *dirp );
    UT_API void closedir( DIR *dirp );
    
    // Do the equivalent of a stat on the last file from readdir or opendir.
    UT_API int statLastRead(const char *path, UT_FileStat &file_stat);

    UT_API char *getUnixCwd( char *buffer, int maxlen );
#else
    #if defined(GAMEOS)
        #include "UT_GameOsUtil.h"
    #endif
    #include <sys/types.h>
    #include <sys/stat.h>
    #include <string.h>
    #include <dirent.h>
    #include <unistd.h>
    #include <stdlib.h>

    inline char *getUnixCwd( char *buffer, int maxlen )
    { return getcwd( buffer, maxlen ); }

    UT_API int statLastRead(const char *path, UT_FileStat &file_stat);
#endif

#endif

---