ModFiles Class Reference

#include <ModFiles.h>

List of all members.

Public Member Functions
	ModFiles ()
virtual	~ModFiles ()
bool	exportModFiles (const std::string &mod, const std::string &fileName)
bool	importModFiles (std::string &mod, const std::string &fileName)
bool	importModFiles (std::string &mod, NetBuffer &buffer)
bool	loadModFiles (const std::string &mod, bool createDir, ProgressCounter *counter=0)
bool	writeModFiles (const std::string &mod)
void	clearData ()
std::map < std::string, ModFileEntry * > &	getFiles ()
Static Public Member Functions
static bool	excludeFile (const std::string &file)
static bool	fileEnding (const std::string &file, const std::string &ext)
Protected Member Functions
bool	loadModDir (const std::string &moddir, const std::string &mod, ProgressCounter *counter=0)
bool	loadModFile (const std::string &fullFileName, const std::string &modDir, const std::string &mod)
bool	loadLocalModFile (const std::string &local, const std::string &mod)
Protected Attributes
std::map < std::string, ModFileEntry * >	files_
Private Member Functions
	ModFiles (const ModFiles &other)
ModFiles &	operator= (ModFiles &other)

---

Detailed Description

Definition at line 28 of file ModFiles.h.

---

Constructor & Destructor Documentation

ModFiles::ModFiles

(

)

Definition at line 28 of file ModFiles.cpp.

ModFiles::~ModFiles

(

)

[virtual]

Definition at line 32 of file ModFiles.cpp.

References files_.

ModFiles::ModFiles

(

const ModFiles &

other

)

[private]

---

Member Function Documentation

bool ModFiles::exportModFiles	(	const std::string &	mod,
		const std::string &	fileName
	)

Definition at line 283 of file ModFiles.cpp.

References NetBuffer::addDataToBuffer(), NetBuffer::addToBuffer(), files_, NetBuffer::getBuffer(), NetBuffer::getBufferUsed(), ModFileEntry::getCompressedBuffer(), ModFileEntry::getCompressedCrc(), ModFileEntry::getFileName(), ModFileEntry::getUncompressedSize(), NetBuffer::reset(), and S3D::ScorchedProtocolVersion.

Referenced by DisplayFrame::onExportMod().

bool ModFiles::importModFiles	(	std::string &	mod,
		const std::string &	fileName
	)

Definition at line 332 of file ModFiles.cpp.

References NetBuffer::addDataToBuffer().

Referenced by DisplayFrame::onImportMod(), and ServerWebSettingsHandler::SettingsModHandler::processRequest().

bool ModFiles::importModFiles	(	std::string &	mod,
		NetBuffer &	buffer
	)

Definition at line 348 of file ModFiles.cpp.

References NetBuffer::allocate(), S3D::dialogMessage(), files_, S3D::formatStringBuffer(), NetBuffer::getBuffer(), ModFileEntry::getCompressedBuffer(), NetBufferReader::getDataFromBuffer(), NetBufferReader::getFromBuffer(), S3D::ScorchedProtocolVersion, NetBuffer::setBufferUsed(), ModFileEntry::setCompressedCrc(), ModFileEntry::setFileName(), ModFileEntry::setUncompressedSize(), and LangStringUtil::strcmp().

bool ModFiles::loadModFiles	(	const std::string &	mod,
		bool	createDir,
		ProgressCounter *	counter = 0
	)

Definition at line 83 of file ModFiles.cpp.

References S3D::dialogMessage(), S3D::dirExists(), S3D::dirMake(), file, files_, S3D::formatStringBuffer(), ModFileEntry::getCompressedSize(), S3D::getDataFile(), FileList::getFiles(), S3D::getGlobalModFile(), S3D::getModFile(), ModFileEntry::getUncompressedSize(), LANG_RESOURCE, loadLocalModFile(), loadModDir(), Logger::log(), ProgressCounter::setNewOp(), and LangStringUtil::strlen().

Referenced by DisplayFrame::onExportMod().

bool ModFiles::writeModFiles

(

const std::string &

mod

)

Definition at line 252 of file ModFiles.cpp.

References S3D::dirExists(), S3D::dirMake(), files_, ModFileEntry::getFileName(), S3D::getModFile(), and ModFileEntry::writeModFile().

Referenced by DisplayFrame::onImportMod(), and ServerWebSettingsHandler::SettingsModHandler::processRequest().

void ModFiles::clearData

(

)

Definition at line 271 of file ModFiles.cpp.

References NetBuffer::clear(), files_, and ModFileEntry::getCompressedBuffer().

Referenced by ClientInitializeHandler::initialize().

std::map<std::string, ModFileEntry *>& ModFiles::getFiles

(

)

[inline]

Definition at line 43 of file ModFiles.h.

References files_.

Referenced by ServerHaveModFilesHandler::processMessage(), ClientFileHandler::processMessage(), ClientConnectionAcceptHandler::processMessage(), ServerWebHandler::ModsHandler::processRequest(), and ServerFileServer::sendNextFile().

bool ModFiles::excludeFile

(

const std::string &

file

)

[static]

Definition at line 60 of file ModFiles.cpp.

References fileEnding(), S3D::formatStringBuffer(), and Logger::log().

Referenced by loadModFile(), and ModFileEntry::writeModFile().

bool ModFiles::fileEnding	(	const std::string &	file,
		const std::string &	ext
	)			[static]

Definition at line 44 of file ModFiles.cpp.

Referenced by excludeFile(), and ModFileEntry::loadModFile().

bool ModFiles::loadModDir	(	const std::string &	moddir,
		const std::string &	mod,
		ProgressCounter *	counter = 0
	)			[protected]

Definition at line 175 of file ModFiles.cpp.

References FileList::getFiles(), loadModFile(), and ProgressCounter::setNewPercentage().

Referenced by loadModFiles().

bool ModFiles::loadModFile	(	const std::string &	fullFileName,
		const std::string &	modDir,
		const std::string &	mod
	)			[protected]

Definition at line 202 of file ModFiles.cpp.

References _strlwr, S3D::dialogMessage(), excludeFile(), file, S3D::fileDos2Unix(), files_, S3D::formatStringBuffer(), ModFileEntry::loadModFile(), ModFileEntry::setFileName(), and LangStringUtil::strcmp().

Referenced by loadLocalModFile(), and loadModDir().

bool ModFiles::loadLocalModFile	(	const std::string &	local,
		const std::string &	mod
	)			[protected]

Definition at line 164 of file ModFiles.cpp.

References S3D::getDataFile(), and loadModFile().

Referenced by loadModFiles().

ModFiles& ModFiles::operator=

(

ModFiles &

other

)

[private]

---

Member Data Documentation

std::map<std::string, ModFileEntry *> ModFiles::files_ [protected]

Definition at line 48 of file ModFiles.h.

Referenced by clearData(), exportModFiles(), getFiles(), importModFiles(), loadModFile(), loadModFiles(), writeModFiles(), and ~ModFiles().

---

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

• src/common/engine/ModFiles.h
• src/common/engine/ModFiles.cpp

---