#include <PackFile.h>

Inheritance diagram for vpkpp::PackFile:

Collaboration diagram for vpkpp::PackFile:

Public Types
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
	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
virtual constexpr std::string_view	getGUID () const =0
	Get the GUID corresponding to the pack file type.
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.
virtual std::optional< std::vector< std::byte > >	readEntry (const std::string &path_) const =0
	Try to read the entry's data to a bytebuffer.
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.
virtual bool	bake (const std::string &outputDir_, BakeOptions options, const EntryCallback &callback)=0
	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 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 std::string	getTruncatedFilestem () const
	/home/user/pak01_dir.vpk -> pak01
virtual Attribute	getSupportedEntryAttributes () const
	Returns a list of supported entry attributes Mostly for GUI programs that show entries and their metadata in a table ;)
virtual	operator std::string () const

Static Public Member Functions
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.

Protected Types
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)>

Protected Member Functions
	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
virtual void	addEntryInternal (Entry &entry, const std::string &path, std::vector< std::byte > &buffer, EntryOptions options)=0
std::string	getBakeOutputDir (const std::string &outputDir) const
void	mergeUnbakedEntries ()
void	setFullFilePath (const std::string &outputDir)
std::string	cleanEntryPath (const std::string &path) const

Static Protected Member Functions
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)

Protected Attributes
std::string	fullFilePath
EntryTrie	entries
EntryTrie	unbakedEntries

Detailed Description

Definition at line 26 of file PackFile.h.

Member Typedef Documentation

◆ EntryCallback

using vpkpp::PackFile::EntryCallback = EntryCallbackBase<void>

Definition at line 38 of file PackFile.h.

◆ EntryCallbackBase

template<typename R>

using vpkpp::PackFile::EntryCallbackBase = std::function<R(const std::string& path, const Entry& entry)>

Accepts the entry's path and metadata.

Definition at line 37 of file PackFile.h.

◆ EntryCreation

using vpkpp::PackFile::EntryCreation = std::function<EntryOptions(const std::string& path)>

Definition at line 42 of file PackFile.h.

◆ EntryPredicate

using vpkpp::PackFile::EntryPredicate = EntryCallbackBase<bool>

Definition at line 39 of file PackFile.h.

◆ EntryTrie

using vpkpp::PackFile::EntryTrie = tsl::htrie_map<char, Entry>

Definition at line 44 of file PackFile.h.

◆ OpenFactoryFunction

using vpkpp::PackFile::OpenFactoryFunction = std::function<std::unique_ptr<PackFile>(const std::string& path, const EntryCallback& callback, const OpenPropertyRequest& requestProperty)>

protected

Definition at line 224 of file PackFile.h.

◆ OpenFactoryFunctionBasic

using vpkpp::PackFile::OpenFactoryFunctionBasic = std::function<std::unique_ptr<PackFile>(const std::string& path, const EntryCallback& callback)>

protected

Definition at line 223 of file PackFile.h.

◆ OpenPropertyRequest

using vpkpp::PackFile::OpenPropertyRequest = std::function<std::vector<std::byte>(PackFile* packFile, OpenProperty property)>

Definition at line 33 of file PackFile.h.

Member Enumeration Documentation

◆ OpenProperty

enum class vpkpp::PackFile::OpenProperty

strong

Enumerator
DECRYPTION_KEY

Definition at line 28 of file PackFile.h.

Constructor & Destructor Documentation

◆ PackFile() [1/3]

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

delete

◆ PackFile() [2/3]

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

defaultnoexcept

◆ ~PackFile()

virtual vpkpp::PackFile::~PackFile ( )

virtualdefault

◆ PackFile() [3/3]

PackFile::PackFile ( std::string fullFilePath_ )

explicitprotected

Definition at line 112 of file PackFile.cpp.

Member Function Documentation

◆ addDirectory() [1/2]

void PackFile::addDirectory	(	const std::string &	entryBaseDir,
		const std::string &	dir,
		EntryOptions	options = {} )

Adds new entries using the contents of a given directory.

Definition at line 234 of file PackFile.cpp.

◆ addDirectory() [2/2]

void PackFile::addDirectory	(	const std::string &	entryBaseDir_,
		const std::string &	dir,
		const EntryCreation &	creation )

Adds new entries using the contents of a given directory.

Definition at line 240 of file PackFile.cpp.

◆ addEntry() [1/3]

void PackFile::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.

Definition at line 197 of file PackFile.cpp.

◆ addEntry() [2/3]

void PackFile::addEntry	(	const std::string &	path,
		std::span< const std::byte >	buffer,
		EntryOptions	options = {} )

Add a new entry from a buffer.

Definition at line 230 of file PackFile.cpp.

◆ addEntry() [3/3]

void PackFile::addEntry	(	const std::string &	path,
		std::vector< std::byte > &&	buffer,
		EntryOptions	options = {} )

Add a new entry from a buffer.

Definition at line 215 of file PackFile.cpp.

◆ addEntryInternal()

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

protectedpure virtual

Implemented in vpkpp::APK, vpkpp::EXAMPLE, vpkpp::FGP, vpkpp::GMA, vpkpp::PackFileReadOnly, vpkpp::PAK, vpkpp::PCK, vpkpp::VPK, vpkpp::VPK_VTMB, vpkpp::WAD3, and vpkpp::ZIP.

◆ bake()

virtual bool vpkpp::PackFile::bake	(	const std::string &	outputDir_,
		BakeOptions	options,
		const EntryCallback &	callback )

pure virtual

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

Implemented in bsppp::PakLump, vpkpp::APK, vpkpp::EXAMPLE, vpkpp::FGP, vpkpp::GMA, vpkpp::PackFileReadOnly, vpkpp::PAK, vpkpp::PCK, vpkpp::VPK, vpkpp::VPK_VTMB, vpkpp::WAD3, and vpkpp::ZIP.

◆ cleanEntryPath()

std::string PackFile::cleanEntryPath ( const std::string & path ) const

nodiscardprotected

Definition at line 679 of file PackFile.cpp.

◆ createNewEntry()

Entry PackFile::createNewEntry ( )

staticnodiscardprotected

Definition at line 688 of file PackFile.cpp.

◆ escapeEntryPathForWrite()

std::string PackFile::escapeEntryPathForWrite ( const std::string & path )

staticnodiscard

On Windows, some characters and file names are invalid - this escapes the given entry path.

Definition at line 619 of file PackFile.cpp.

◆ extractAll() [1/2]

bool PackFile::extractAll	(	const std::string &	outputDir,
		bool	createUnderPackFileDir = true ) const

Extract the contents of the pack file to disk at the given directory.

Definition at line 398 of file PackFile.cpp.

◆ extractAll() [2/2]

bool PackFile::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.

Definition at line 420 of file PackFile.cpp.

◆ extractDirectory()

bool PackFile::extractDirectory	(	const std::string &	dir_,
		const std::string &	outputDir ) const

Extract the given directory to disk under the given output directory.

Definition at line 373 of file PackFile.cpp.

◆ extractEntry()

bool PackFile::extractEntry	(	const std::string &	entryPath,
		const std::string &	filepath ) const

Extract the given entry to disk at the given file path.

Definition at line 354 of file PackFile.cpp.

◆ findEntry()

std::optional< Entry > PackFile::findEntry	(	const std::string &	path_,
		bool	includeUnbaked = true ) const

nodiscard

Try to find an entry given the file path.

Definition at line 166 of file PackFile.cpp.

◆ getBakedEntries()

const PackFile::EntryTrie & PackFile::getBakedEntries ( ) const

nodiscard

Get entries saved to disk.

Definition at line 485 of file PackFile.cpp.

◆ getBakeOutputDir()

std::string PackFile::getBakeOutputDir ( const std::string & outputDir ) const

nodiscardprotected

Definition at line 643 of file PackFile.cpp.

◆ getEntryCount()

std::size_t PackFile::getEntryCount ( bool includeUnbaked = true ) const

nodiscard

Get the number of entries in the pack file.

Definition at line 493 of file PackFile.cpp.

◆ getFilename()

std::string PackFile::getFilename ( ) const

nodiscard

/home/user/pak01_dir.vpk -> pak01_dir.vpk

Definition at line 594 of file PackFile.cpp.

◆ getFilepath()

std::string_view PackFile::getFilepath ( ) const

nodiscard

/home/user/pak01_dir.vpk

Definition at line 586 of file PackFile.cpp.

◆ getFilestem()

std::string PackFile::getFilestem ( ) const

nodiscard

/home/user/pak01_dir.vpk -> pak01_dir

Definition at line 603 of file PackFile.cpp.

◆ getGUID()

virtual constexpr std::string_view vpkpp::PackFile::getGUID ( ) const

nodiscardconstexprpure virtual

Get the GUID corresponding to the pack file type.

Implemented in bsppp::PakLump, vpkpp::APK, vpkpp::EXAMPLE, vpkpp::FGP, vpkpp::FPX, vpkpp::GCF, vpkpp::GMA, vpkpp::HOG, vpkpp::OL, vpkpp::OO7, vpkpp::ORE, vpkpp::PAK, vpkpp::PCK, vpkpp::VPK, vpkpp::VPK_VTMB, vpkpp::VPP, vpkpp::WAD3, vpkpp::XZP, and vpkpp::ZIP.

◆ getOpenableExtensions()

std::vector< std::string > PackFile::getOpenableExtensions ( )

staticnodiscard

Returns a sorted list of supported extensions for opening, e.g. {".bsp", ".vpk"}.

Definition at line 131 of file PackFile.cpp.

◆ getOpenExtensionRegistry()

std::unordered_map< std::string, std::vector< PackFile::OpenFactoryFunction > > & PackFile::getOpenExtensionRegistry ( )

staticprotected

Definition at line 707 of file PackFile.cpp.

◆ getSupportedEntryAttributes()

Attribute PackFile::getSupportedEntryAttributes ( ) const

nodiscardvirtual

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

Reimplemented in vpkpp::APK, vpkpp::EXAMPLE, vpkpp::FGP, vpkpp::GCF, vpkpp::GMA, vpkpp::HOG, vpkpp::OL, vpkpp::OO7, vpkpp::ORE, vpkpp::PAK, vpkpp::PCK, vpkpp::VPK, vpkpp::VPK_VTMB, vpkpp::VPP, vpkpp::WAD3, vpkpp::XZP, and vpkpp::ZIP.

Definition at line 611 of file PackFile.cpp.

◆ getTruncatedFilename()

std::string PackFile::getTruncatedFilename ( ) const

nodiscard

/home/user/pak01_dir.vpk -> pak01.vpk

Definition at line 598 of file PackFile.cpp.

◆ getTruncatedFilepath()

std::string PackFile::getTruncatedFilepath ( ) const

nodiscard

/home/user/pak01_dir.vpk -> /home/user/pak01

Definition at line 590 of file PackFile.cpp.

◆ getTruncatedFilestem()

std::string PackFile::getTruncatedFilestem ( ) const

nodiscardvirtual

/home/user/pak01_dir.vpk -> pak01

Reimplemented in vpkpp::VPK, and vpkpp::VPK_VTMB.

Definition at line 607 of file PackFile.cpp.

◆ getUnbakedEntries()

const PackFile::EntryTrie & PackFile::getUnbakedEntries ( ) const

nodiscard

Get entries that have been added but not yet baked.

Definition at line 489 of file PackFile.cpp.

◆ hasEntry()

bool PackFile::hasEntry	(	const std::string &	path,
		bool	includeUnbaked = true ) const

nodiscard

Check if an entry exists given the file path.

Definition at line 162 of file PackFile.cpp.

◆ hasEntryChecksums()

virtual constexpr bool vpkpp::PackFile::hasEntryChecksums ( ) const

inlinenodiscardconstexprvirtual

Returns true if the format has a checksum for each entry.

Reimplemented in vpkpp::GCF, vpkpp::GMA, vpkpp::VPK, and vpkpp::ZIP.

Definition at line 71 of file PackFile.h.

◆ hasPackFileChecksum()

bool PackFile::hasPackFileChecksum ( ) const

nodiscardvirtual

Returns true if the entire file has a checksum.

Reimplemented in vpkpp::GMA, vpkpp::OO7, and vpkpp::VPK.

Definition at line 146 of file PackFile.cpp.

◆ hasPackFileSignature()

bool PackFile::hasPackFileSignature ( ) const

nodiscardvirtual

Returns true if the file is signed.

Reimplemented in vpkpp::VPK.

Definition at line 154 of file PackFile.cpp.

◆ isCaseSensitive()

virtual constexpr bool vpkpp::PackFile::isCaseSensitive ( ) const

inlinenodiscardconstexprvirtual

Does the format support case-sensitive file names?

Reimplemented in bsppp::PakLump, vpkpp::EXAMPLE, vpkpp::GCF, vpkpp::OL, vpkpp::OO7, vpkpp::PCK, and vpkpp::ZIP.

Definition at line 94 of file PackFile.h.

◆ isInstanceOf()

template<typename T>
requires requires (const T&) {{T::GUID} -> std::convertible_to<std::string_view>;}

bool vpkpp::PackFile::isInstanceOf ( ) const

inlinenodiscard

Check if the pack file is an instance of the given pack file class.

Definition at line 66 of file PackFile.h.

◆ isReadOnly()

virtual constexpr bool vpkpp::PackFile::isReadOnly ( ) const

inlinenodiscardconstexprvirtualnoexcept

Reimplemented in vpkpp::PackFileReadOnly, and vpkpp::ZIP.

Definition at line 112 of file PackFile.h.

◆ mergeUnbakedEntries()

void PackFile::mergeUnbakedEntries ( )

protected

Definition at line 658 of file PackFile.cpp.

◆ open()

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

staticnodiscard

Open a generic pack file. The parser is selected based on the file extension.

Definition at line 117 of file PackFile.cpp.

◆ operator std::string()

PackFile::operator std::string ( ) const

explicitnodiscardvirtual

Reimplemented in bsppp::PakLump, vpkpp::EXAMPLE, vpkpp::FGP, vpkpp::GCF, vpkpp::GMA, vpkpp::OO7, vpkpp::PackFileReadOnly, vpkpp::PCK, and vpkpp::VPK.

Definition at line 615 of file PackFile.cpp.

◆ operator=() [1/2]

PackFile & vpkpp::PackFile::operator= ( const PackFile & other )

delete

◆ operator=() [2/2]

PackFile & vpkpp::PackFile::operator= ( PackFile && other )

defaultnoexcept

◆ operator[]()

std::optional< std::vector< std::byte > > PackFile::operator[] ( const std::string & path_ ) const

nodiscard

Definition at line 179 of file PackFile.cpp.

◆ readEntry()

virtual std::optional< std::vector< std::byte > > vpkpp::PackFile::readEntry ( const std::string & path_ ) const

nodiscardpure virtual

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

Implemented in vpkpp::APK, vpkpp::EXAMPLE, vpkpp::FGP, vpkpp::GCF, vpkpp::GMA, vpkpp::HOG, vpkpp::OL, vpkpp::OO7, vpkpp::ORE, vpkpp::PAK, vpkpp::PCK, vpkpp::VPK, vpkpp::VPK_VTMB, vpkpp::VPP, vpkpp::WAD3, vpkpp::XZP, and vpkpp::ZIP.

◆ readEntryText()

std::optional< std::string > PackFile::readEntryText ( const std::string & path ) const

nodiscard

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

Definition at line 183 of file PackFile.cpp.

◆ readUnbakedEntry()

std::optional< std::vector< std::byte > > PackFile::readUnbakedEntry ( const Entry & entry )

staticnodiscardprotected

Definition at line 692 of file PackFile.cpp.

◆ registerOpenExtensionForTypeFactory() [1/2]

const PackFile::OpenFactoryFunction & PackFile::registerOpenExtensionForTypeFactory	(	std::string_view	extension,
		const OpenFactoryFunction &	factory )

staticprotected

Definition at line 718 of file PackFile.cpp.

◆ registerOpenExtensionForTypeFactory() [2/2]

const PackFile::OpenFactoryFunction & PackFile::registerOpenExtensionForTypeFactory	(	std::string_view	extension,
		const OpenFactoryFunctionBasic &	factory )

staticprotected

Definition at line 712 of file PackFile.cpp.

◆ removeDirectory()

std::size_t PackFile::removeDirectory ( const std::string & dirName_ )

virtual

Remove a directory.

Reimplemented in vpkpp::FGP, and vpkpp::VPK.

Definition at line 336 of file PackFile.cpp.

◆ removeEntry()

bool PackFile::removeEntry ( const std::string & path_ )

virtual

Remove an entry.

Reimplemented in vpkpp::FGP, and vpkpp::VPK.

Definition at line 319 of file PackFile.cpp.

◆ renameDirectory()

bool PackFile::renameDirectory	(	const std::string &	oldDir_,
		const std::string &	newDir_ )

virtual

Rename an existing directory.

Reimplemented in vpkpp::FGP.

Definition at line 290 of file PackFile.cpp.

◆ renameEntry()

bool PackFile::renameEntry	(	const std::string &	oldPath_,
		const std::string &	newPath_ )

virtual

Rename an existing entry.

Reimplemented in vpkpp::FGP.

Definition at line 270 of file PackFile.cpp.

◆ runForAllEntries() [1/2]

void PackFile::runForAllEntries	(	const EntryCallback &	operation,
		bool	includeUnbaked = true ) const

Run a callback for each entry in the pack file.

Definition at line 502 of file PackFile.cpp.

◆ runForAllEntries() [2/2]

void PackFile::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.

Definition at line 516 of file PackFile.cpp.

◆ runForAllEntriesInternal() [1/2]

void PackFile::runForAllEntriesInternal	(	const std::function< void(const std::string &, Entry &)> &	operation,
		bool	includeUnbaked = true )

protected

Definition at line 544 of file PackFile.cpp.

◆ runForAllEntriesInternal() [2/2]

void PackFile::runForAllEntriesInternal	(	const std::string &	parentDir,
		const std::function< void(const std::string &, Entry &)> &	operation,
		bool	recursive = true,
		bool	includeUnbaked = true )

protected

Definition at line 558 of file PackFile.cpp.

◆ setFullFilePath()

void PackFile::setFullFilePath ( const std::string & outputDir )

protected

Definition at line 674 of file PackFile.cpp.

◆ verifyEntryChecksums()

std::vector< std::string > PackFile::verifyEntryChecksums ( ) const

nodiscardvirtual

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.

Reimplemented in vpkpp::GCF, vpkpp::GMA, vpkpp::VPK, and vpkpp::ZIP.

Definition at line 142 of file PackFile.cpp.

◆ verifyEntryChecksumsUsingCRC32()

std::vector< std::string > PackFile::verifyEntryChecksumsUsingCRC32 ( ) const

nodiscardprotected

Definition at line 629 of file PackFile.cpp.

◆ verifyPackFileChecksum()

bool PackFile::verifyPackFileChecksum ( ) const

nodiscardvirtual

Verify the checksum of the entire file, returns true on success Will return true if there is no checksum ability in the format.

Reimplemented in vpkpp::GMA, vpkpp::OO7, and vpkpp::VPK.

Definition at line 150 of file PackFile.cpp.

◆ verifyPackFileSignature()

bool PackFile::verifyPackFileSignature ( ) const

nodiscardvirtual

Verify the file signature, returns true on success Will return true if there is no signature ability in the format.

Reimplemented in vpkpp::VPK.

Definition at line 158 of file PackFile.cpp.

Member Data Documentation

◆ entries

EntryTrie vpkpp::PackFile::entries

protected

Definition at line 233 of file PackFile.h.

◆ fullFilePath

std::string vpkpp::PackFile::fullFilePath

protected

Definition at line 232 of file PackFile.h.

◆ unbakedEntries

EntryTrie vpkpp::PackFile::unbakedEntries

protected

Definition at line 234 of file PackFile.h.

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

include/vpkpp/PackFile.h
src/vpkpp/PackFile.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ EntryCallback

◆ EntryCallbackBase

◆ EntryCreation

◆ EntryPredicate

◆ EntryTrie

◆ OpenFactoryFunction

◆ OpenFactoryFunctionBasic

◆ OpenPropertyRequest

Member Enumeration Documentation

◆ OpenProperty

Constructor & Destructor Documentation

◆ PackFile() [1/3]

◆ PackFile() [2/3]

◆ ~PackFile()

◆ PackFile() [3/3]

Member Function Documentation

◆ addDirectory() [1/2]

◆ addDirectory() [2/2]

◆ addEntry() [1/3]

◆ addEntry() [2/3]

◆ addEntry() [3/3]

◆ addEntryInternal()

◆ bake()

◆ cleanEntryPath()

◆ createNewEntry()

◆ escapeEntryPathForWrite()

◆ extractAll() [1/2]

◆ extractAll() [2/2]

◆ extractDirectory()

◆ extractEntry()

◆ findEntry()

◆ getBakedEntries()

◆ getBakeOutputDir()

◆ getEntryCount()

◆ getFilename()

◆ getFilepath()

◆ getFilestem()

◆ getGUID()

◆ getOpenableExtensions()

◆ getOpenExtensionRegistry()

◆ getSupportedEntryAttributes()

◆ getTruncatedFilename()

◆ getTruncatedFilepath()

◆ getTruncatedFilestem()

◆ getUnbakedEntries()

◆ hasEntry()

◆ hasEntryChecksums()

◆ hasPackFileChecksum()

◆ hasPackFileSignature()

◆ isCaseSensitive()

◆ isInstanceOf()

◆ isReadOnly()

◆ mergeUnbakedEntries()

◆ open()

◆ operator std::string()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]()

◆ readEntry()

◆ readEntryText()

◆ readUnbakedEntry()

◆ registerOpenExtensionForTypeFactory() [1/2]

◆ registerOpenExtensionForTypeFactory() [2/2]

◆ removeDirectory()

◆ removeEntry()

◆ renameDirectory()

◆ renameEntry()

◆ runForAllEntries() [1/2]

◆ runForAllEntries() [2/2]

◆ runForAllEntriesInternal() [1/2]

◆ runForAllEntriesInternal() [2/2]