Create typedef for file instance and change it from 4 to 1 bytes

Author: xezon

Core/GameEngine/Include/Common/ArchiveFileSystem.h

@@ -140,17 +140,17 @@ class ArchiveFileSystem : public SubsystemInterface
 	virtual void					closeAllArchiveFiles( void ) = 0;								///< Close all Archive files currently open
 
 	// File operations
-	virtual File*					openFile( const Char *filename, Int access = 0, UnsignedInt instance = 0);	///< Search Archive files for specified file name and open it if found
+	virtual File*					openFile( const Char *filename, Int access = 0, FileInstance instance = 0);	///< Search Archive files for specified file name and open it if found
 	virtual void					closeAllFiles( void ) = 0;									///< Close all files associated with Archive files
-	virtual Bool					doesFileExist(const Char *filename, UnsignedInt instance = 0) const;	///< return true if that file exists in an archive file somewhere.
+	virtual Bool					doesFileExist(const Char *filename, FileInstance instance = 0) const;	///< return true if that file exists in an archive file somewhere.
 
 	void					getFileListInDirectory(const AsciiString& currentDirectory, const AsciiString& originalDirectory, const AsciiString& searchName, FilenameList &filenameList, Bool searchSubdirectories) const; ///< search the given directory for files matching the searchName (egs. *.ini, *.rep).  Possibly search subdirectories.  Scans each Archive file.
-	Bool					getFileInfo(const AsciiString& filename, FileInfo *fileInfo, UnsignedInt instance = 0) const; ///< see FileSystem.h
+	Bool					getFileInfo(const AsciiString& filename, FileInfo *fileInfo, FileInstance instance = 0) const; ///< see FileSystem.h
 
 	virtual Bool	loadBigFilesFromDirectory(AsciiString dir, AsciiString fileMask, Bool overwrite = FALSE) = 0;
 
 	// Unprotected this for copy-protection routines
-	ArchiveFile* getArchiveFile(const AsciiString& filename, UnsignedInt instance = 0) const;
+	ArchiveFile* getArchiveFile(const AsciiString& filename, FileInstance instance = 0) const;
 
 	void loadMods( void );
 

Core/GameEngine/Include/Common/FileSystem.h

@@ -66,6 +66,7 @@
 
 typedef std::set<AsciiString, rts::less_than_nocase<AsciiString> > FilenameList;
 typedef FilenameList::iterator FilenameListIter;
+typedef UnsignedByte FileInstance;
 
 //----------------------------------------------------------------------------
 //           Type Defines
@@ -80,7 +81,7 @@ typedef FilenameList::iterator FilenameListIter;
 #define USER_W3D_DIR_PATH "%sW3D/"					///< .w3d files live here
 #define USER_TGA_DIR_PATH "%sTextures/"		///< User .tga texture files live here
 
-// the following defines are only to be used while maintaining legacy compatability
+// the following defines are only to be used while maintaining legacy compatibility
 // with old files until they are completely gone and in the regular art set
 #ifdef MAINTAIN_LEGACY_FILES
 #define LEGACY_W3D_DIR_PATH "../LegacyArt/W3D/"				///< .w3d files live here
@@ -144,10 +145,10 @@ class FileSystem : public SubsystemInterface
 	void reset();
 	void update();
 
-	File* openFile( const Char *filename, Int access = File::NONE, size_t bufferSize = File::BUFFERSIZE, UnsignedInt instance = 0 ); ///< opens a File interface to the specified file
-	Bool doesFileExist(const Char *filename, UnsignedInt instance = 0) const; ///< returns TRUE if the file exists.  filename should have no directory.
+	File* openFile( const Char *filename, Int access = File::NONE, size_t bufferSize = File::BUFFERSIZE, FileInstance instance = 0 ); ///< opens a File interface to the specified file
+	Bool doesFileExist(const Char *filename, FileInstance instance = 0) const; ///< returns TRUE if the file exists.  filename should have no directory.
 	void getFileListInDirectory(const AsciiString& directory, const AsciiString& searchName, FilenameList &filenameList, Bool searchSubdirectories) const; ///< search the given directory for files matching the searchName (egs. *.ini, *.rep).  Possibly search subdirectories.
-	Bool getFileInfo(const AsciiString& filename, FileInfo *fileInfo, UnsignedInt instance = 0) const; ///< fills in the FileInfo struct for the file given. returns TRUE if successful.
+	Bool getFileInfo(const AsciiString& filename, FileInfo *fileInfo, FileInstance instance = 0) const; ///< fills in the FileInfo struct for the file given. returns TRUE if successful.
 
 	Bool createDirectory(AsciiString directory); ///< create a directory of the given name.
 
@@ -162,9 +163,9 @@ class FileSystem : public SubsystemInterface
 #if ENABLE_FILESYSTEM_EXISTENCE_CACHE
 	struct FileExistData
 	{
-		FileExistData() : instanceExists(0), instanceDoesNotExist(~0u) {}
-		UnsignedInt instanceExists;
-		UnsignedInt instanceDoesNotExist;
+		FileExistData() : instanceExists(0), instanceDoesNotExist(~FileInstance(0)) {}
+		FileInstance instanceExists;
+		FileInstance instanceDoesNotExist;
 	};
 	typedef std::hash_map<
 		rts::string_key<AsciiString>, FileExistData,

Core/GameEngine/Source/Common/System/ArchiveFileSystem.cpp

@@ -238,7 +238,7 @@ void ArchiveFileSystem::loadMods()
 	}
 }
 
-Bool ArchiveFileSystem::doesFileExist(const Char *filename, UnsignedInt instance) const
+Bool ArchiveFileSystem::doesFileExist(const Char *filename, FileInstance instance) const
 {
 	ArchivedDirectoryInfoResult result = const_cast<ArchiveFileSystem*>(this)->getArchivedDirectoryInfo(filename);
 
@@ -289,7 +289,7 @@ ArchiveFileSystem::ArchivedDirectoryInfoResult ArchiveFileSystem::getArchivedDir
 	return result;
 }
 
-File * ArchiveFileSystem::openFile(const Char *filename, Int access, UnsignedInt instance)
+File * ArchiveFileSystem::openFile(const Char *filename, Int access, FileInstance instance)
 {
 	ArchiveFile* archive = getArchiveFile(filename, instance);
 
@@ -299,7 +299,7 @@ File * ArchiveFileSystem::openFile(const Char *filename, Int access, UnsignedInt
 	return archive->openFile(filename, access);
 }
 
-Bool ArchiveFileSystem::getFileInfo(const AsciiString& filename, FileInfo *fileInfo, UnsignedInt instance) const
+Bool ArchiveFileSystem::getFileInfo(const AsciiString& filename, FileInfo *fileInfo, FileInstance instance) const
 {
 	if (fileInfo == NULL) {
 		return FALSE;
@@ -317,7 +317,7 @@ Bool ArchiveFileSystem::getFileInfo(const AsciiString& filename, FileInfo *fileI
 	return archive->getFileInfo(filename, fileInfo);
 }
 
-ArchiveFile* ArchiveFileSystem::getArchiveFile(const AsciiString& filename, UnsignedInt instance) const
+ArchiveFile* ArchiveFileSystem::getArchiveFile(const AsciiString& filename, FileInstance instance) const
 {
 	ArchivedDirectoryInfoResult result = const_cast<ArchiveFileSystem*>(this)->getArchivedDirectoryInfo(filename.str());
 

Core/GameEngine/Source/Common/System/FileSystem.cpp

@@ -171,7 +171,7 @@ void		FileSystem::reset( void )
 // FileSystem::open
 //============================================================================
 
-File*		FileSystem::openFile( const Char *filename, Int access, size_t bufferSize, UnsignedInt instance )
+File*		FileSystem::openFile( const Char *filename, Int access, size_t bufferSize, FileInstance instance )
 {
 	USE_PERF_TIMER(FileSystem)
 	File *file = NULL;
@@ -196,7 +196,7 @@ File*		FileSystem::openFile( const Char *filename, Int access, size_t bufferSize
 				if (it != m_fileExist.end())
 				{
 					++it->second.instanceExists;
-					if (it->second.instanceDoesNotExist != ~0u)
+					if (it->second.instanceDoesNotExist != ~FileInstance(0))
 						++it->second.instanceDoesNotExist;
 				}
 				else
@@ -221,7 +221,7 @@ File*		FileSystem::openFile( const Char *filename, Int access, size_t bufferSize
 // FileSystem::doesFileExist
 //============================================================================
 
-Bool FileSystem::doesFileExist(const Char *filename, UnsignedInt instance) const
+Bool FileSystem::doesFileExist(const Char *filename, FileInstance instance) const
 {
 	USE_PERF_TIMER(FileSystem)
 
@@ -282,7 +282,7 @@ void FileSystem::getFileListInDirectory(const AsciiString& directory, const Asci
 //============================================================================
 // FileSystem::getFileInfo
 //============================================================================
-Bool FileSystem::getFileInfo(const AsciiString& filename, FileInfo *fileInfo, UnsignedInt instance) const
+Bool FileSystem::getFileInfo(const AsciiString& filename, FileInfo *fileInfo, FileInstance instance) const
 {
 	USE_PERF_TIMER(FileSystem)