[TOOLS] GenBIG - A CLI Tool for BIG Archives #535
Conversation
DevGeniusCode
added
Minor
| @@ -3,6 +3,7 @@ | |||
| # Build useful tool binaries. | |||
| if(GENZH_BUILD_ZEROHOUR_TOOLS) | |||
| add_subdirectory(DebugWindow) | |||
| add_subdirectory(GenBIG) | |||
There was a problem hiding this comment.
I suggest call it BigArchiver or similar.
| case '-': | ||
| switch (argv[i][1]) { | ||
| case 'a': // Add file or directory to the archive | ||
| case 'd': // Delete file from archive |
There was a problem hiding this comment.
I suggest we use cxxopts for command line, to standardize setups. You can see example how it is used in https://github.com/xezon/unassemblize
| m_outputDir = nullptr; | ||
| } | ||
| if (m_archiveName != nullptr) { | ||
| delete[] m_archiveName; |
There was a problem hiding this comment.
Prefer to not use new/delete where so possible and use things like STL containers (std::string for strings) and smart pointers (std::unique_ptr, std::shared_ptr).
When interfacing with Engine, can also use AsciiString and UnicodeString.
| // | ||
|
|
||
| #ifndef GENZH_BIGFILE_H | ||
| #define GENZH_BIGFILE_H |
There was a problem hiding this comment.
Use #pragma once instead of header include guards.
| // Handle archive operations | ||
| bool addToArchive(); | ||
| bool addDirectoryToArchive(const char* path); | ||
| bool deleteFromArchive(const char* name = NULL); |
| bool setPaths(const char* path); | ||
|
|
||
| private: | ||
| Win32BIGFileSystem * m_archiveFileSystem; // or Win32BIGFileSystem? |
There was a problem hiding this comment.
It looks odd that this class derives from Win32BIGFileSystem, but also owns a pointer to Win32BIGFileSystem.
Before jumping into big implementations, I suggest to take a moment and think carefully about the design.
Upon a first look, we could try to have something like:
class Win32BIGFileRW : public Win32BIGFile
class Win32BIGFileSystemRW : public Win32BIGFileSystem
You would just need to find an elegant way to make Win32BIGFileSystem use Win32BIGFileRW as well, probably with a template.
This could allow making a new Read Write version of the archive and its system, while reusing what is already there for opening and reading archives.
But perhaps the design of the Win32BIGFile and Win32BIGFileSystem make it hard to fit in the write functionality nicely. In that case a different strategy may be better.
Please also be mindful about performance when implementing this.
This PR introduces a CLI tool for handling BIG archives used in the Generals Zero Hour game. The tool leverages existing classes in the source code to work with BIG archives and files.
Note
The tool is heavily a work in progress and under investigation.
Features:
The initial focus is on the simplest feature: listing the files in an archive. This will help to understand how to utilize the existing classes in the source code.
Relevant Classes in the Source Code:
ArchiveFile: Represents a general archive file containing multiple subfiles, providing methods for interacting with and accessing the files inside the archive.ArchiveFileSystem: Manages a collection of archive files, enabling operations such as opening, closing, and searching for files across multiple archives.Win32BIGFile: A specific implementation ofArchiveFilefor handling BIG archive files, with methods tailored for this file format.Win32BIGFileSystem: A specialized implementation ofArchiveFileSystemdesigned to manage and operate on multiple BIG archive files.Known Issues:
The tool is heavily a work in progress and under investigation. At this stage, it seems that extracting archives is already implemented in the source code, but we need to create and implement a new class for creating BIG archives.
In the
CMakeLists.txtfile, I linked toz_gameengineandz_gameenginedeviceto include the necessary classes from the source code. However, these libraries also include external symbols, which required me to add them in themainfile as well. There is still one additional symbol I haven't figured out how to link.Due to point 2, I am unable to compile the project and test the code. Any help with this issue would be greatly appreciated.