NLMISC::CFile Struct Reference

#include <path.h>

---

Detailed Description

Utility class for file manipulation

Author:

Vianney Lecroart

Nevrax France

Date:

2001

Definition at line 317 of file path.h.

Static Public Member Functions
void	addFileChangeCallback (const std::string &filename, void(*)(const std::string &filename))
void	checkFileChange (TTime frequency=1000)
bool	copyFile (const char *dest, const char *src, bool failIfExists=false)
bool	createDirectory (const std::string &dirname)
bool	deleteFile (const std::string &filename)
bool	fileExists (const std::string &filename)
std::string	findNewFile (const std::string &filename)
std::string	getExtension (const std::string &filename)
uint32	getFileCreationDate (const std::string &filename)
uint32	getFileModificationDate (const std::string &filename)
std::string	getFilename (const std::string &filename)
std::string	getFilenameWithoutExtension (const std::string &filename)
uint32	getFileSize (FILE *f)
uint32	getFileSize (const std::string &filename)
int	getLastSeparator (const std::string &filename)
std::string	getPath (const std::string &filename)
void	getTemporaryOutputFilename (const std::string &originalFilename, std::string &tempFilename)
bool	isDirectory (const std::string &filename)
bool	isExists (const std::string &filename)
bool	moveFile (const char *dest, const char *src)
void	removeFileChangeCallback (const std::string &filename)
bool	setRWAccess (const std::string &filename)

---

Member Function Documentation

void NLMISC::CFile::addFileChangeCallback (  const std::string &  filename, void(*  )(const std::string &filename) )  [static]

Add a callback that will be call when the content file, named filename, changed. The system use the file modification date. To work, you need to call evenly the function checkFileChange(), this function only checks every 1s by default (you can change the default time) ie: void cb (const std::string &filename) { nlinfo ("the file %s changed", filename.c_str()); } CFile::addFileChangeCallback ("myfile.txt", cb); Definition at line 1567 of file path.cpp. Referenced by NLMISC::CEntityIdTranslator::load(). { string fn = CPath::lookup(filename, false, false); if (fn.empty()) { fn = filename; } nlinfo ("PATH: CFile::addFileChangeCallback: I'll check the modification date for this file '%s'", fn.c_str()); FileToCheck.push_back(CFileEntry(fn, cb)); }

void NLMISC::CFile::checkFileChange (  TTime  frequency = 1000  )  [static]

You have to call this function evenly (each frame for example) to enable the file change callback system. If the file not exists and is created in the run time, the callback will be called. If the file exists and is removed in the run time, the callback will be called. Parameters: frequency  the time in millisecond that we wait before check another time (1s by default). Definition at line 1578 of file path.cpp. References buffer, nlwarning, and s. { static TTime lastChecked = CTime::getLocalTime(); if (CTime::getLocalTime() > lastChecked + frequency) { for (uint i = 0; i < FileToCheck.size(); i++) { if(CFile::getFileModificationDate(FileToCheck[i].FileName) != FileToCheck[i].LastModified) { // need to reload it if(FileToCheck[i].Callback != NULL) FileToCheck[i].Callback(FileToCheck[i].FileName); FileToCheck[i].LastModified = CFile::getFileModificationDate(FileToCheck[i].FileName); } } lastChecked = CTime::getLocalTime(); } }

bool NLMISC::CFile::copyFile (  const char *  dest, const char *  src, bool  failIfExists = false )  [static]

Copy a file NB this keeps file attributes Parameters: failIfExists  If the destination file exists, nothing is done, and it returns false. Returns: true if the copy succeeded Definition at line 1653 of file path.cpp. References size, and src. { return CopyMoveFile(dest, src, true, failIfExists); }

bool NLMISC::CFile::createDirectory (  const std::string &  dirname  )  [static]

Create a directory Returns: true if succes Definition at line 1664 of file path.cpp. References uint. { #ifdef NL_OS_WINDOWS return _mkdir(filename.c_str())==0; #else // Set full permissions.... return mkdir(filename.c_str(), 0xFFFF)==0; #endif }

bool NLMISC::CFile::deleteFile (  const std::string &  filename  )  [static]

Delete a file if possible (change the write access if possible) Returns: true if the delete occurs. Definition at line 1757 of file path.cpp. { setRWAccess(filename); int res = unlink (filename.c_str()); if (res == -1) { nlwarning ("PATH: Can't delete file '%s': %d %s", filename.c_str(), errno, strerror(errno)); return false; } return true; }

bool NLMISC::CFile::fileExists (  const std::string &  filename  )  [static]

Return true if the file exists. Warning: this test will also tell that the file does not exist if you don't have the rights to read it (Unix). Definition at line 1402 of file path.cpp. Referenced by NLMISC::CConfigFile::reparse(). { H_AUTO(FileExists); return ! ! fstream( filename.c_str(), ios::in ); }

string NLMISC::CFile::findNewFile (  const std::string &  filename  )  [static]

Return a new filename that doesn't exists. It's used for screenshot filename for example. example: findNewFile("foobar.tga"); will try foobar001.tga, if the file exists, try foobar002.tga and so on until it finds an unexistant file. Definition at line 1409 of file path.cpp. References uint32. { uint32 pos = filename.find_last_of ('.'); if (pos == string::npos) return filename; string start = filename.substr (0, pos); string end = filename.substr (pos); uint num = 0; char numchar[4]; string npath; do { npath = start; smprintf(numchar,4,"%03d",num++); npath += numchar; npath += end; if (!CFile::fileExists(npath)) break; } while (num<999); return npath; }

string NLMISC::CFile::getExtension (  const std::string &  filename  )  [static]

Definition at line 1352 of file path.cpp. Referenced by NL3D::CAnimationSet::loadFromFiles(). { uint32 pos = filename.find_last_of ('.'); if (pos == string::npos) return ""; else return filename.substr (pos + 1); }

uint32 NLMISC::CFile::getFileCreationDate (  const std::string &  filename  )  [static]

Return creation Time of the file. 0 if not found. You have to provide the full path of the file (the function doesn't lookup) Definition at line 1511 of file path.cpp. References NLMISC::FileToCheck, nlinfo, and uint. { uint pos; string fn; if ((pos=filename.find('@')) != string::npos) { fn = CPath::lookup(filename.substr (0, pos)); } else { fn = filename; } #if defined (NL_OS_WINDOWS) struct _stat buf; int result = _stat (fn.c_str (), &buf); #elif defined (NL_OS_UNIX) struct stat buf; int result = stat (fn.c_str (), &buf); #endif if (result != 0) return 0; else return buf.st_ctime; }

uint32 NLMISC::CFile::getFileModificationDate (  const std::string &  filename  )  [static]

Return Time of last modification of file. 0 if not found. You have to provide the full path of the file (the function doesn't lookup) Definition at line 1485 of file path.cpp. Referenced by loadForm(). { uint pos; string fn; if ((pos=filename.find('@')) != string::npos) { fn = CPath::lookup(filename.substr (0, pos)); } else { fn = filename; } #if defined (NL_OS_WINDOWS) struct _stat buf; int result = _stat (fn.c_str (), &buf); #elif defined (NL_OS_UNIX) struct stat buf; int result = stat (fn.c_str (), &buf); #endif if (result != 0) return 0; else return buf.st_mtime; }

string NLMISC::CFile::getFilename (  const std::string &  filename  )  [static]

Retrieve the associated file name. An empty string is returned if the path is invalid Definition at line 1333 of file path.cpp. References nlwarning, and res. Referenced by loadForm(). { uint32 pos = CFile::getLastSeparator(filename); if (pos != string::npos) return filename.substr (pos + 1); else return filename; }

string NLMISC::CFile::getFilenameWithoutExtension (  const std::string &  filename  )  [static]

Definition at line 1342 of file path.cpp. References res. { string filename2 = getFilename (filename); uint32 pos = filename2.find_last_of ('.'); if (pos == string::npos) return filename2; else return filename2.substr (0, pos); }

uint32 NLMISC::CFile::getFileSize (  FILE *  f  )  [static]

Return the size of the file (in bytes). Definition at line 1472 of file path.cpp. References uint, and uint32. { #if defined (NL_OS_WINDOWS) struct _stat buf; int result = _fstat (fileno(f), &buf); #elif defined (NL_OS_UNIX) struct stat buf; int result = fstat (fileno(f), &buf); #endif if (result != 0) return 0; else return buf.st_size; }

uint32 NLMISC::CFile::getFileSize (  const std::string &  filename  )  [static]

Return the size of the file (in bytes). You have to provide the full path of the file (the function doesn't lookup) Definition at line 1434 of file path.cpp. References uint32. { /* FILE *fp = fopen (filename.c_str(), "rb"); if (fp == NULL) return 0; nlfseek64 (fp, 0, SEEK_END); uint32 size = ftell (fp); fclose (fp); return size;*/ /* const char *s = filename.c_str(); int h = _open (s, _O_RDONLY | _O_BINARY); _lseek (h, 0, SEEK_END); uint32 size = _tell (h); _close (h); return size; */ if (filename.find('@') != string::npos) { uint32 fs = 0, bfo; bool c, d; CBigFile::getInstance().getFile (filename, fs, bfo, c, d); return fs; } else { #if defined (NL_OS_WINDOWS) struct _stat buf; int result = _stat (filename.c_str (), &buf); #elif defined (NL_OS_UNIX) struct stat buf; int result = stat (filename.c_str (), &buf); #endif if (result != 0) return 0; else return buf.st_size; } }

int NLMISC::CFile::getLastSeparator (  const std::string &  filename  )  [static]

Return the position between [begin,end[ of the last separator between path and filename ('/' or '\'). If there's no separator, it returns string::npos. Definition at line 1319 of file path.cpp. { uint32 pos = filename.find_last_of ('/'); if (pos == string::npos) { pos = filename.find_last_of ('\\'); if (pos == string::npos) { pos = filename.find_last_of ('@'); } } return pos; }

string NLMISC::CFile::getPath (  const std::string &  filename  )  [static]

Retrieve the associated file path with the trailing slash. Returns an empty string if the path is invalid Definition at line 1361 of file path.cpp. { uint32 pos = CFile::getLastSeparator(filename); if (pos != string::npos) return filename.substr (0, pos + 1); else return ""; }

void NLMISC::CFile::getTemporaryOutputFilename (  const std::string &  originalFilename, std::string &  tempFilename )  [static]

Get temporary output filename. Call this method to get a temporary output filename. If you have successfuly saved your data, delete the old filename and move the new one. Definition at line 1769 of file path.cpp. { uint i = 0; do tempFilename = originalFilename+".tmp"+toString (i++); while (CFile::isExists(tempFilename)); }

bool NLMISC::CFile::isDirectory (  const std::string &  filename  )  [static]

Just to know if it is a directory. _FileName empty and path not !!! Definition at line 1370 of file path.cpp. References num, NLMISC::smprintf(), uint, and uint32. { #ifdef NL_OS_WINDOWS DWORD res = GetFileAttributes(filename.c_str()); if (res == ~0U) { nlwarning ("PATH: %s is not a valid file / directory name", filename.c_str ()); return false; } return (res & FILE_ATTRIBUTE_DIRECTORY) != 0; #else // NL_OS_WINDOWS struct stat buf; int res = stat (filename.c_str (), &buf); if (res == -1) { nlwarning ("PATH: can't stat '%s' error %d '%s'", filename.c_str(), errno, strerror(errno)); return false; } return (buf.st_mode & S_IFDIR) != 0; #endif // NL_OS_WINDOWS }

bool NLMISC::CFile::isExists (  const std::string &  filename  )  [static]

Return true if the file OR directory exists. Warning: this test will also tell that the file does not exist if you don't have the rights to read it (Unix). Definition at line 1392 of file path.cpp. References num. { #ifdef NL_OS_WINDOWS return (GetFileAttributes(filename.c_str()) != ~0U); #else // NL_OS_WINDOWS struct stat buf; return stat (filename.c_str (), &buf) == 0; #endif // NL_OS_WINDOWS }

bool NLMISC::CFile::moveFile (  const char *  dest, const char *  src )  [static]

Move a file NB this keeps file attributes Definition at line 1658 of file path.cpp. References size. { return CopyMoveFile(dest, src, false); }

void NLMISC::CFile::removeFileChangeCallback (  const std::string &  filename  )  [static]

Remove a file that was previously added by addFileChangeCallback Definition at line 1549 of file path.cpp. References NLMISC::FileToCheck. { string fn = CPath::lookup(filename, false, false); if (fn.empty()) { fn = filename; } for (uint i = 0; i < FileToCheck.size(); i++) { if(FileToCheck[i].FileName == fn) { nlinfo ("PATH: CFile::removeFileChangeCallback: '%s' is removed from checked files modification", fn.c_str()); FileToCheck.erase(FileToCheck.begin()+i); return; } } }

bool NLMISC::CFile::setRWAccess (  const std::string &  filename  )  [static]

Try to set the file access to read/write if not already set. return true if the file doesn't exists or if the file already have RW access. Work actually only on Windows and returns always true on other platforms. Returns: true if RW access is granted Definition at line 1720 of file path.cpp. References nlwarning, and res. { #ifdef NL_OS_WINDOWS // if the file exists and there's no write access if (_access (filename.c_str(), 00) == 0 && _access (filename.c_str(), 06) == -1) { // try to set the read/write access if (_chmod (filename.c_str(), _S_IREAD | _S_IWRITE) == -1) { nlwarning ("PATH: Can't set RW access to file '%s': %d %s", filename.c_str(), errno, strerror(errno)); return false; } } #else // if the file exists and there's no write access if (access (filename.c_str(), F_OK) == 0) { // try to set the read/write access if (chmod (filename.c_str(), S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH) == -1) { nlwarning ("PATH: Can't set RW access to file '%s': %d %s", filename.c_str(), errno, strerror(errno)); return false; } } else { nlwarning("PATH: Can't access to file '%s'", filename.c_str()); } #endif return true; }

---

The documentation for this struct was generated from the following files:

• path.h
• path.cpp

---