#include <VPK_VTMB.h>

Inheritance diagram for vpkpp::VPK_VTMB:

Collaboration diagram for vpkpp::VPK_VTMB:

Public Member Functions
constexpr std::string_view	getGUID () const override
	Get the GUID corresponding to the pack file type.
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.
std::string	getTruncatedFilestem () const override
	/home/user/pak01_dir.vpk -> pak01
Attribute	getSupportedEntryAttributes () const override
	Returns a list of supported entry attributes Mostly for GUI programs that show entries and their metadata in a table ;)
Public Member Functions inherited from vpkpp::PackFile
	PackFile (const PackFile &other)=delete
PackFile &	operator= (const PackFile &other)=delete
	PackFile (PackFile &&other) noexcept=default
PackFile &	operator= (PackFile &&other) noexcept=default
virtual	~PackFile ()=default
template<typename T> requires requires (const T&) {{T::GUID} -> std::convertible_to<std::string_view>;}
bool	isInstanceOf () const
	Check if the pack file is an instance of the given pack file class.
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< Entry >	findEntry (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
void	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.
void	addEntry (const std::string &path, std::vector< std::byte > &&buffer, EntryOptions options={})
	Add a new entry from a buffer.
void	addEntry (const std::string &path, std::span< const std::byte > buffer, EntryOptions options={})
	Add a new entry from a buffer.
void	addDirectory (const std::string &entryBaseDir, const std::string &dir, EntryOptions options={})
	Adds new entries using the contents of a given directory.
void	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	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 EntryTrie &	getBakedEntries () const
	Get entries saved to disk.
const EntryTrie &	getUnbakedEntries () 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	operator std::string () const

Static Public Member Functions
static std::unique_ptr< PackFile >	create (const std::string &path)
	Create Vampire: The Masquerade - Bloodlines VPK files.
static std::unique_ptr< PackFile >	open (const std::string &path, const EntryCallback &callback=nullptr)
	Open Vampire: The Masquerade - Bloodlines VPK files.
Static Public Member Functions inherited from vpkpp::PackFile
static std::unique_ptr< PackFile >	open (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.

Static Public Attributes
static constexpr std::string_view	GUID = "5942653FBD0F4A2D9EF33CDDA668C396"

Protected Member Functions
void	openNumbered (uint32_t archiveIndex, const std::string &path, const EntryCallback &callback)
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
std::vector< uint32_t >	knownArchives
uint32_t	currentArchive = 0
Protected Attributes inherited from vpkpp::PackFile
std::string	fullFilePath
EntryTrie	entries
EntryTrie	unbakedEntries

Additional Inherited Members
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>
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 OpenFactoryFunction &	registerOpenExtensionForTypeFactory (std::string_view extension, const OpenFactoryFunctionBasic &factory)
static const OpenFactoryFunction &	registerOpenExtensionForTypeFactory (std::string_view extension, const OpenFactoryFunction &factory)

Detailed Description

Definition at line 11 of file VPK_VTMB.h.

Member Function Documentation

◆ addEntryInternal()

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

overrideprotectedvirtual

Implements vpkpp::PackFile.

Definition at line 111 of file VPK_VTMB.cpp.

◆ bake()

bool VPK_VTMB::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 119 of file VPK_VTMB.cpp.

◆ create()

std::unique_ptr< PackFile > VPK_VTMB::create ( const std::string & path )

static

Create Vampire: The Masquerade - Bloodlines VPK files.

Definition at line 12 of file VPK_VTMB.cpp.

◆ getGUID()

std::string_view vpkpp::VPK_VTMB::getGUID ( ) const

inlinenodiscardconstexproverridevirtual

Get the GUID corresponding to the pack file type.

Implements vpkpp::PackFile.

Definition at line 21 of file VPK_VTMB.h.

◆ getSupportedEntryAttributes()

Attribute VPK_VTMB::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 204 of file VPK_VTMB.cpp.

◆ getTruncatedFilestem()

std::string VPK_VTMB::getTruncatedFilestem ( ) const

nodiscardoverridevirtual

/home/user/pak01_dir.vpk -> pak01

Reimplemented from vpkpp::PackFile.

Definition at line 198 of file VPK_VTMB.cpp.

◆ open()

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

staticnodiscard

Open Vampire: The Masquerade - Bloodlines VPK files.

Definition at line 23 of file VPK_VTMB.cpp.

◆ openNumbered()

void VPK_VTMB::openNumbered	(	uint32_t	archiveIndex,
		const std::string &	path,
		const EntryCallback &	callback )

protected

Definition at line 55 of file VPK_VTMB.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 201 of file PackFile.cpp.

◆ readEntry()

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

nodiscardoverridevirtual

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

Implements vpkpp::PackFile.

Definition at line 92 of file VPK_VTMB.cpp.

Member Data Documentation

◆ currentArchive

uint32_t vpkpp::VPK_VTMB::currentArchive = 0

protected

Definition at line 41 of file VPK_VTMB.h.

◆ GUID

std::string_view vpkpp::VPK_VTMB::GUID = "5942653FBD0F4A2D9EF33CDDA668C396"

staticconstexpr

Definition at line 19 of file VPK_VTMB.h.

◆ knownArchives

std::vector<uint32_t> vpkpp::VPK_VTMB::knownArchives

protected

Definition at line 40 of file VPK_VTMB.h.

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

include/vpkpp/format/VPK_VTMB.h
src/vpkpp/format/VPK_VTMB.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addEntryInternal()

◆ bake()

◆ create()

◆ getGUID()

◆ getSupportedEntryAttributes()

◆ getTruncatedFilestem()

◆ open()

◆ openNumbered()

◆ PackFile() [1/3]

◆ PackFile() [2/3]

◆ PackFile() [3/3]

◆ readEntry()

Member Data Documentation

◆ currentArchive

◆ GUID

◆ knownArchives