SourcePP
Several modern C++20 libraries for sanely parsing Valve's formats.
Loading...
Searching...
No Matches
vpkpp::TAB Class Reference

#include <TAB.h>

Inheritance diagram for vpkpp::TAB:
Collaboration diagram for vpkpp::TAB:

Public Types

enum class  Version { JC1_LE , JC1_BE }
Public Types inherited from vpkpp::PackFile
enum class  OpenProperty { DECRYPTION_KEY }
using OpenPropertyRequest = std::function<std::vector<std::byte>(PackFile* packFile, OpenProperty property)>
template<typename R>
using EntryCallbackBase = std::function<R(const std::string& path, const Entry& entry)>
 Accepts the entry's path and metadata.
using EntryCallback = EntryCallbackBase<void>
using EntryPredicate = EntryCallbackBase<bool>
using EntryCreation = std::function<EntryOptions(const std::string& path)>
using EntryTrie = tsl::htrie_map<char, Entry>

Public Member Functions

std::optional< std::vector< std::byte > > readEntry (const std::string &path_) const override
 Try to read the entry's data to a bytebuffer.
bool bake (const std::string &outputDir_, BakeOptions options, const EntryCallback &callback) override
 If output folder is an empty string, it will overwrite the original.
Attribute getSupportedEntryAttributes () const override
 Returns a list of supported entry attributes Mostly for GUI programs that show entries and their metadata in a table ;).
 operator std::string () const override
Version getVersion () const
void setVersion (Version version_)
uint32_t getSectorSize () const
void setSectorSize (uint32_t sectorSize_)
Public Member Functions inherited from vpkpp::PackFile
 PackFile (const PackFile &other)=delete
PackFileoperator= (const PackFile &other)=delete
 PackFile (PackFile &&other) noexcept=default
PackFileoperator= (PackFile &&other) noexcept=default
virtual ~PackFile ()=default
virtual constexpr bool hasEntryChecksums () const
 Returns true if the format has a checksum for each entry.
virtual std::vector< std::string > verifyEntryChecksums () const
 Verify the checksums of each file, if a file fails the check its path will be added to the vector If there is no checksum ability in the format, it will return an empty vector.
virtual bool hasPackFileChecksum () const
 Returns true if the entire file has a checksum.
virtual bool verifyPackFileChecksum () const
 Verify the checksum of the entire file, returns true on success Will return true if there is no checksum ability in the format.
virtual bool hasPackFileSignature () const
 Returns true if the file is signed.
virtual bool verifyPackFileSignature () const
 Verify the file signature, returns true on success Will return true if there is no signature ability in the format.
virtual constexpr bool isCaseSensitive () const
 Does the format support case-sensitive file names?
bool hasEntry (const std::string &path, bool includeUnbaked=true) const
 Check if an entry exists given the file path.
std::optional< EntryfindEntry (const std::string &path_, bool includeUnbaked=true) const
 Try to find an entry given the file path.
std::optional< std::vector< std::byte > > operator[] (const std::string &path_) const
std::optional< std::string > readEntryText (const std::string &path) const
 Try to read the entry's data to a string.
virtual constexpr bool isReadOnly () const noexcept
bool addEntry (const std::string &entryPath, const std::string &filepath, EntryOptions options={})
 Add a new entry from a file path - the first parameter is the path in the PackFile, the second is the path on disk.
bool addEntry (const std::string &path, std::vector< std::byte > &&buffer, EntryOptions options={})
 Add a new entry from a buffer.
bool addEntry (const std::string &path, std::span< const std::byte > buffer, EntryOptions options={})
 Add a new entry from a buffer.
int64_t addDirectory (const std::string &entryBaseDir, const std::string &dir, EntryOptions options={})
 Adds new entries using the contents of a given directory.
int64_t addDirectory (const std::string &entryBaseDir_, const std::string &dir, const EntryCreation &creation)
 Adds new entries using the contents of a given directory.
virtual bool renameEntry (const std::string &oldPath_, const std::string &newPath_)
 Rename an existing entry.
virtual bool renameDirectory (const std::string &oldDir_, const std::string &newDir_)
 Rename an existing directory.
virtual bool removeEntry (const std::string &path_)
 Remove an entry.
virtual std::size_t removeDirectory (const std::string &dirName_)
 Remove a directory.
bool bake ()
 If output folder is an empty string, it will overwrite the original.
bool bake (const std::string &outputDir_)
 If output folder is an empty string, it will overwrite the original.
bool bake (const std::string &outputDir_, BakeOptions options)
 If output folder is an empty string, it will overwrite the original.
bool extractEntry (const std::string &entryPath, const std::string &filepath) const
 Extract the given entry to disk at the given file path.
bool extractDirectory (const std::string &dir_, const std::string &outputDir) const
 Extract the given directory to disk under the given output directory.
bool extractAll (const std::string &outputDir, bool createUnderPackFileDir=true) const
 Extract the contents of the pack file to disk at the given directory.
bool extractAll (const std::string &outputDir, const EntryPredicate &predicate, bool stripSharedDirs=true) const
 Extract the contents of the pack file to disk at the given directory - only entries which match the predicate are extracted.
const EntryTriegetBakedEntries () const
 Get entries saved to disk.
const EntryTriegetUnbakedEntries () const
 Get entries that have been added but not yet baked.
std::size_t getEntryCount (bool includeUnbaked=true) const
 Get the number of entries in the pack file.
void runForAllEntries (const EntryCallback &operation, bool includeUnbaked=true) const
 Run a callback for each entry in the pack file.
void runForAllEntries (const std::string &parentDir, const EntryCallback &operation, bool recursive=true, bool includeUnbaked=true) const
 Run a callback for each entry in the pack file under the parent directory.
std::string_view getFilepath () const
 /home/user/pak01_dir.vpk
std::string getTruncatedFilepath () const
 /home/user/pak01_dir.vpk -> /home/user/pak01
std::string getFilename () const
 /home/user/pak01_dir.vpk -> pak01_dir.vpk
std::string getTruncatedFilename () const
 /home/user/pak01_dir.vpk -> pak01.vpk
std::string getFilestem () const
 /home/user/pak01_dir.vpk -> pak01_dir
virtual std::string getTruncatedFilestem () const
 /home/user/pak01_dir.vpk -> pak01

Static Public Member Functions

static std::unique_ptr< PackFilecreate (const std::string &path, Version version=Version::JC1_LE, uint32_t sectorSize=2048)
 Create a TAB file.
static std::unique_ptr< PackFileopen (const std::string &path, const EntryCallback &callback=nullptr)
 Open a TAB file.
static uint32_t hashFilePath (const std::string &filepath)
Static Public Member Functions inherited from vpkpp::PackFile
static std::unique_ptr< PackFileopen (const std::string &path, const EntryCallback &callback=nullptr, const OpenPropertyRequest &requestProperty=nullptr)
 Open a generic pack file. The parser is selected based on the file extension.
static std::vector< std::string > getOpenableExtensions ()
 Returns a sorted list of supported extensions for opening, e.g. {".bsp", ".vpk"}.
static std::string escapeEntryPathForWrite (const std::string &path)
 On Windows, some characters and file names are invalid - this escapes the given entry path.

Protected Member Functions

void addEntryInternal (Entry &entry, const std::string &path, std::vector< std::byte > &buffer, EntryOptions options) override
 PackFile (const PackFile &other)=delete
 PackFile (PackFile &&other) noexcept=default
 PackFile (std::string fullFilePath_)
Protected Member Functions inherited from vpkpp::PackFile
 PackFile (std::string fullFilePath_)
void runForAllEntriesInternal (const std::function< void(const std::string &, Entry &)> &operation, bool includeUnbaked=true)
void runForAllEntriesInternal (const std::string &parentDir, const std::function< void(const std::string &, Entry &)> &operation, bool recursive=true, bool includeUnbaked=true)
std::vector< std::string > verifyEntryChecksumsUsingCRC32 () const
std::string getBakeOutputDir (const std::string &outputDir) const
void mergeUnbakedEntries ()
void setFullFilePath (const std::string &outputDir)
std::string cleanEntryPath (const std::string &path) const

Protected Attributes

Version version = Version::JC1_LE
uint32_t sectorSize = 0
uint32_t numArchives = 0
Protected Attributes inherited from vpkpp::PackFile
std::string fullFilePath
EntryTrie entries
EntryTrie unbakedEntries

Additional Inherited Members

Protected Types inherited from vpkpp::PackFile
using OpenFactoryFunctionBasic = std::function<std::unique_ptr<PackFile>(const std::string& path, const EntryCallback& callback)>
using OpenFactoryFunction = std::function<std::unique_ptr<PackFile>(const std::string& path, const EntryCallback& callback, const OpenPropertyRequest& requestProperty)>
Static Protected Member Functions inherited from vpkpp::PackFile
static Entry createNewEntry ()
static std::optional< std::vector< std::byte > > readUnbakedEntry (const Entry &entry)
static std::unordered_map< std::string, std::vector< OpenFactoryFunction > > & getOpenExtensionRegistry ()
static const OpenFactoryFunctionregisterOpenExtensionForTypeFactory (std::string_view extension, const OpenFactoryFunctionBasic &factory)
static const OpenFactoryFunctionregisterOpenExtensionForTypeFactory (std::string_view extension, const OpenFactoryFunction &factory)

Detailed Description

Definition at line 21 of file TAB.h.

Member Enumeration Documentation

◆ Version

enum class vpkpp::TAB::Version
strong
Enumerator
JC1_LE 
JC1_BE 

Definition at line 23 of file TAB.h.

Member Function Documentation

◆ addEntryInternal()

void TAB::addEntryInternal ( Entry & entry,
const std::string & path,
std::vector< std::byte > & buffer,
EntryOptions options )
overrideprotectedvirtual

Implements vpkpp::PackFile.

Definition at line 149 of file TAB.cpp.

◆ bake()

bool TAB::bake ( const std::string & outputDir_,
BakeOptions options,
const EntryCallback & callback )
overridevirtual

If output folder is an empty string, it will overwrite the original.

Implements vpkpp::PackFile.

Definition at line 159 of file TAB.cpp.

◆ create()

std::unique_ptr< PackFile > TAB::create ( const std::string & path,
Version version = Version::JC1_LE,
uint32_t sectorSize = 2048 )
static

Create a TAB file.

Definition at line 27 of file TAB.cpp.

◆ getSectorSize()

uint32_t TAB::getSectorSize ( ) const
nodiscard

Definition at line 292 of file TAB.cpp.

◆ getSupportedEntryAttributes()

Attribute TAB::getSupportedEntryAttributes ( ) const
nodiscardoverridevirtual

Returns a list of supported entry attributes Mostly for GUI programs that show entries and their metadata in a table ;).

Reimplemented from vpkpp::PackFile.

Definition at line 275 of file TAB.cpp.

◆ getVersion()

TAB::Version TAB::getVersion ( ) const
nodiscard

Definition at line 284 of file TAB.cpp.

◆ hashFilePath()

uint32_t TAB::hashFilePath ( const std::string & filepath)
staticnodiscard

Definition at line 300 of file TAB.cpp.

◆ open()

std::unique_ptr< PackFile > TAB::open ( const std::string & path,
const EntryCallback & callback = nullptr )
staticnodiscard

Open a TAB file.

Definition at line 39 of file TAB.cpp.

◆ operator std::string()

TAB::operator std::string ( ) const
explicitnodiscardoverridevirtual

Reimplemented from vpkpp::PackFile.

Definition at line 280 of file TAB.cpp.

◆ PackFile() [1/3]

vpkpp::PackFile::PackFile ( const PackFile & other)
protecteddelete

◆ PackFile() [2/3]

vpkpp::PackFile::PackFile ( PackFile && other)
protecteddefaultnoexcept

◆ PackFile() [3/3]

PackFile::PackFile ( std::string fullFilePath_)
explicitprotected

Definition at line 200 of file PackFile.cpp.

◆ readEntry()

std::optional< std::vector< std::byte > > TAB::readEntry ( const std::string & path_) const
nodiscardoverridevirtual

Try to read the entry's data to a bytebuffer.

Implements vpkpp::PackFile.

Definition at line 130 of file TAB.cpp.

◆ setSectorSize()

void TAB::setSectorSize ( uint32_t sectorSize_)

Definition at line 296 of file TAB.cpp.

◆ setVersion()

void TAB::setVersion ( Version version_)

Definition at line 288 of file TAB.cpp.

Member Data Documentation

◆ numArchives

uint32_t vpkpp::TAB::numArchives = 0
protected

Definition at line 59 of file TAB.h.

◆ sectorSize

uint32_t vpkpp::TAB::sectorSize = 0
protected

Definition at line 58 of file TAB.h.

◆ version

Version vpkpp::TAB::version = Version::JC1_LE
protected

Definition at line 57 of file TAB.h.


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