style: Clean up whitespace and formatting across \Core\GameEngine files

Author: DevGeniusCode

Core/GameEngine/Include/Common/ArchiveFile.h

@@ -35,13 +35,13 @@
 class File;
 
 /**
-  *	An archive file is itself a collection of sub files. Each file inside the archive file
-	* has a unique name by which it can be accessed. The ArchiveFile object class is the
-	* runtime interface to the mix file and the sub files. Each file inside the mix
-	* file can be accessed by the openFile().
-	*
-	* ArchiveFile interfaces can be created by the TheArchiveFileSystem object.
-	*/
+ *	An archive file is itself a collection of sub files. Each file inside the archive file
+ * has a unique name by which it can be accessed. The ArchiveFile object class is the
+ * runtime interface to the mix file and the sub files. Each file inside the mix
+ * file can be accessed by the openFile().
+ *
+ * ArchiveFile interfaces can be created by the TheArchiveFileSystem object.
+ */
 //===============================
 
 class ArchiveFile
@@ -50,23 +50,23 @@ class ArchiveFile
 	ArchiveFile();
 	virtual ~ArchiveFile();
 
-	virtual Bool					getFileInfo( const AsciiString& filename, FileInfo *fileInfo) const = 0;	///< fill in the fileInfo struct with info about the file requested.
-	virtual File*					openFile( const Char *filename, Int access = 0) = 0;	///< Open the specified file within the archive file
-	virtual void					closeAllFiles() = 0;									///< Close all file opened in this archive file
-	virtual AsciiString		getName() = 0;												///< Returns the name of the archive file
-	virtual AsciiString		getPath() = 0;												///< Returns full path and name of archive file
-	virtual void					setSearchPriority( Int new_priority ) = 0;	///< Set this archive file's search priority
-	virtual void					close() = 0;													///< Close this archive file
-	void									attachFile(File *file);
+	virtual Bool getFileInfo(const AsciiString& filename, FileInfo* fileInfo) const = 0; ///< fill in the fileInfo struct with info about the file requested.
+	virtual File* openFile(const Char* filename, Int access = 0) = 0;                    ///< Open the specified file within the archive file
+	virtual void closeAllFiles() = 0;                                                    ///< Close all file opened in this archive file
+	virtual AsciiString getName() = 0;                                                   ///< Returns the name of the archive file
+	virtual AsciiString getPath() = 0;                                                   ///< Returns full path and name of archive file
+	virtual void setSearchPriority(Int new_priority) = 0;                                ///< Set this archive file's search priority
+	virtual void close() = 0;                                                            ///< Close this archive file
+	void attachFile(File* file);
 
-	void									getFileListInDirectory(const AsciiString& currentDirectory, const AsciiString& originalDirectory, const AsciiString& searchName, FilenameList &filenameList, Bool searchSubdirectories) const;
-	void									getFileListInDirectory(const DetailedArchivedDirectoryInfo *dirInfo, const AsciiString& currentDirectory, const AsciiString& searchName, FilenameList &filenameList, Bool searchSubdirectories) const;
+	void getFileListInDirectory(const AsciiString& currentDirectory, const AsciiString& originalDirectory, const AsciiString& searchName, FilenameList& filenameList, Bool searchSubdirectories) const;
+	void getFileListInDirectory(const DetailedArchivedDirectoryInfo* dirInfo, const AsciiString& currentDirectory, const AsciiString& searchName, FilenameList& filenameList, Bool searchSubdirectories) const;
 
-	void									addFile(const AsciiString& path, const ArchivedFileInfo *fileInfo); ///< add this file to our directory tree.
+	void addFile(const AsciiString& path, const ArchivedFileInfo* fileInfo); ///< add this file to our directory tree.
 
 protected:
-	const ArchivedFileInfo *		getArchivedFileInfo(const AsciiString& filename) const;	///< return the ArchivedFileInfo from the directory tree.
+	const ArchivedFileInfo* getArchivedFileInfo(const AsciiString& filename) const; ///< return the ArchivedFileInfo from the directory tree.
 
-	File *m_file; ///< file pointer to the archive file on disk.  Kept open so we don't have to continuously open and close the file all the time.
+	File* m_file; ///< file pointer to the archive file on disk.  Kept open so we don't have to continuously open and close the file all the time.
 	DetailedArchivedDirectoryInfo m_rootDirectory;
 };

Core/GameEngine/Include/Common/ArchiveFileSystem.h

@@ -65,43 +65,42 @@ class ArchiveFile;
 //           Type Defines
 //----------------------------------------------------------------------------
 
-
 //===============================
 // ArchiveFileSystem
 //===============================
 /**
-  *	Creates and manages ArchiveFile interfaces. ArchiveFiles can be accessed
-	* by calling the openArchiveFile() member. ArchiveFiles can be accessed by
-	* name or by File interface.
-	*
-	* openFile() member searches all Archive files for the specified sub file.
-	*/
+ *	Creates and manages ArchiveFile interfaces. ArchiveFiles can be accessed
+ * by calling the openArchiveFile() member. ArchiveFiles can be accessed by
+ * name or by File interface.
+ *
+ * openFile() member searches all Archive files for the specified sub file.
+ */
 //===============================
 class ArchivedDirectoryInfo;
 class DetailedArchivedDirectoryInfo;
 class ArchivedFileInfo;
 
 typedef std::map<AsciiString, DetailedArchivedDirectoryInfo> DetailedArchivedDirectoryInfoMap; // Archived directory name to detailed archived directory info
-typedef std::map<AsciiString, ArchivedDirectoryInfo> ArchivedDirectoryInfoMap; // Archived directory name to archived directory info
-typedef std::map<AsciiString, ArchivedFileInfo> ArchivedFileInfoMap; // Archived file name to archived file info
-typedef std::map<AsciiString, ArchiveFile *> ArchiveFileMap; // Archive file name to archive data
-typedef std::multimap<AsciiString, ArchiveFile *> ArchivedFileLocationMap; // Archived file name to archive data
+typedef std::map<AsciiString, ArchivedDirectoryInfo> ArchivedDirectoryInfoMap;                 // Archived directory name to archived directory info
+typedef std::map<AsciiString, ArchivedFileInfo> ArchivedFileInfoMap;                           // Archived file name to archived file info
+typedef std::map<AsciiString, ArchiveFile*> ArchiveFileMap;                                    // Archive file name to archive data
+typedef std::multimap<AsciiString, ArchiveFile*> ArchivedFileLocationMap;                      // Archived file name to archive data
 
 class ArchivedDirectoryInfo
 {
 public:
-	AsciiString								m_path; // The full path to this directory
-	AsciiString								m_directoryName; // The current directory
-	ArchivedDirectoryInfoMap	m_directories; // Contained leaf directories
-	ArchivedFileLocationMap		m_files; // Contained files
+	AsciiString m_path;                     // The full path to this directory
+	AsciiString m_directoryName;            // The current directory
+	ArchivedDirectoryInfoMap m_directories; // Contained leaf directories
+	ArchivedFileLocationMap m_files;        // Contained files
 };
 
 class DetailedArchivedDirectoryInfo
 {
 public:
-	AsciiString												m_directoryName;
-	DetailedArchivedDirectoryInfoMap	m_directories;
-	ArchivedFileInfoMap								m_files;
+	AsciiString m_directoryName;
+	DetailedArchivedDirectoryInfoMap m_directories;
+	ArchivedFileInfoMap m_files;
 };
 
 class ArchivedFileInfo
@@ -113,13 +112,12 @@ class ArchivedFileInfo
 	UnsignedInt m_size;
 
 	ArchivedFileInfo()
-		: m_offset(0)
-		, m_size(0)
+	  : m_offset(0)
+	  , m_size(0)
 	{
 	}
 };
 
-
 class ArchiveFileSystem : public SubsystemInterface
 {
 public:
@@ -132,19 +130,19 @@ class ArchiveFileSystem : public SubsystemInterface
 	virtual void postProcessLoad() = 0;
 
 	// ArchiveFile operations
-	virtual ArchiveFile*	openArchiveFile( const Char *filename ) = 0;		///< Create new or return existing Archive file from file name
-	virtual void					closeArchiveFile( const Char *filename ) = 0;		///< Close the one specified big file.
-	virtual void					closeAllArchiveFiles() = 0;								///< Close all Archive files currently open
+	virtual ArchiveFile* openArchiveFile(const Char* filename) = 0; ///< Create new or return existing Archive file from file name
+	virtual void closeArchiveFile(const Char* filename) = 0;        ///< Close the one specified big file.
+	virtual void closeAllArchiveFiles() = 0;                        ///< Close all Archive files currently open
 
 	// File operations
-	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() = 0;									///< Close all files associated with Archive files
-	virtual Bool					doesFileExist(const Char *filename, FileInstance instance = 0) const;	///< return true if that file exists in an archive file somewhere.
+	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() = 0;                                                        ///< Close all files associated with Archive files
+	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, FileInstance instance = 0) const; ///< see FileSystem.h
+	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, FileInstance instance = 0) const;                                                                                                 ///< see FileSystem.h
 
-	virtual Bool	loadBigFilesFromDirectory(AsciiString dir, AsciiString fileMask, Bool overwrite = FALSE) = 0;
+	virtual Bool loadBigFilesFromDirectory(AsciiString dir, AsciiString fileMask, Bool overwrite = FALSE) = 0;
 
 	// Unprotected this for copy-protection routines
 	ArchiveFile* getArchiveFile(const AsciiString& filename, FileInstance instance = 0) const;
@@ -156,7 +154,9 @@ class ArchiveFileSystem : public SubsystemInterface
 protected:
 	struct ArchivedDirectoryInfoResult
 	{
-		ArchivedDirectoryInfoResult() : dirInfo(nullptr) {}
+		ArchivedDirectoryInfoResult()
+		  : dirInfo(nullptr)
+		{}
 		Bool valid() const { return dirInfo != nullptr; }
 
 		ArchivedDirectoryInfo* dirInfo;
@@ -165,14 +165,13 @@ class ArchiveFileSystem : public SubsystemInterface
 
 	ArchivedDirectoryInfoResult getArchivedDirectoryInfo(const Char* directory);
 
-	virtual void loadIntoDirectoryTree(ArchiveFile *archiveFile, Bool overwrite = FALSE);	///< load the archive file's header information and apply it to the global archive directory tree.
+	virtual void loadIntoDirectoryTree(ArchiveFile* archiveFile, Bool overwrite = FALSE); ///< load the archive file's header information and apply it to the global archive directory tree.
 
 	ArchiveFileMap m_archiveFileMap;
 	ArchivedDirectoryInfo m_rootDirectory;
 };
 
-
-extern ArchiveFileSystem *TheArchiveFileSystem;
+extern ArchiveFileSystem* TheArchiveFileSystem;
 
 //----------------------------------------------------------------------------
 //           Inlining