Helper class to handle file operations. More...

#include <CCFileUtilsApple.h>

Inheritance diagram for FileUtilsApple:

Public Member Functions
virtual std::string	getWritablePath () const override
	Gets the writable path. More...

virtual bool	isFileExist (const std::string &filePath) const override
	Checks whether a file exists. More...

var	isFileExist ( var filePath)
	Checks whether a file exists. More...

local	isFileExist ( local filePath)
	Checks whether a file exists. More...

virtual std::string	getFullPathForDirectoryAndFilename (const std::string &directory, const std::string &filename) override
	Gets full path for the directory and the filename. More...

local	getFullPathForDirectoryAndFilename ( local directory, local filename)
	Gets full path for the directory and the filename. More...

virtual ValueMap	getValueMapFromFile (const std::string &filename) override
	Converts the contents of a file to a ValueMap. More...

local	getValueMapFromFile ( local filename)
	Converts the contents of a file to a ValueMap. More...

virtual bool	writeToFile (ValueMap &dict, const std::string &fullPath) override
	Write a ValueMap to a plist file. More...

local	writeToFile ( local dict, local fullPath)
	Write a ValueMap to a plist file. More...

virtual ValueVector	getValueVectorFromFile (const std::string &filename) override
	Converts the contents of a file to a ValueVector. More...

Public Member Functions inherited from FileUtils
virtual	~FileUtils ()
	The destructor of FileUtils. More...

virtual void	purgeCachedEntries ()
	Purges the file searching cache. More...

local	purgeCachedEntries ()
	Purges the file searching cache. More...

virtual std::string	getStringFromFile (const std::string &filename)
	Gets string from a file. More...

var	getStringFromFile ( var filename)
	Gets string from a file. More...

local	getStringFromFile ( local filename)
	Gets string from a file. More...

virtual Data	getDataFromFile (const std::string &filename)
	Creates binary data from a file. More...

var	getDataFromFile ( var filename)
	Creates binary data from a file. More...

local	getDataFromFile ( local filename)
	Creates binary data from a file. More...

virtual CC_DEPRECATED_ATTRIBUTE unsigned char *	getFileData (const std::string &filename, const char mode, ssize_t size)
	Gets resource file data. More...

local	getFileData ( local filename, local mode, local size)
	Gets resource file data. More...

virtual unsigned char *	getFileDataFromZip (const std::string &zipFilePath, const std::string &filename, ssize_t *size)
	Gets resource file data from a zip file. More...

virtual std::string	fullPathForFilename (const std::string &filename)
	Returns the fullpath for a given filename. More...

local	fullPathForFilename ( local filename)
	Returns the fullpath for a given filename. More...

virtual void	loadFilenameLookupDictionaryFromFile (const std::string &filename)
	Loads the filenameLookup dictionary from the contents of a filename. More...

virtual void	setFilenameLookupDictionary (const ValueMap &filenameLookupDict)
	Sets the filenameLookup dictionary. More...

virtual std::string	fullPathFromRelativeFile (const std::string &filename, const std::string &relativeFile)
	Gets full path from a file name and the path of the reletive file. More...

local	fullPathFromRelativeFile ( local filename, local relativeFile)
	Gets full path from a file name and the path of the reletive file. More...

virtual void	setSearchResolutionsOrder (const std::vector< std::string > &searchResolutionsOrder)
	Sets the array that contains the search order of the resources. More...

virtual void	addSearchResolutionsOrder (const std::string &order)
	Append search order of the resources. More...

virtual const std::vector < std::string > &	getSearchResolutionsOrder ()
	Gets the array that contains the search order of the resources. More...

virtual void	setSearchPaths (const std::vector< std::string > &searchPaths)
	Sets the array of search paths. More...

var	setSearchPaths ( var searchPaths)
	Sets the array of search paths. More...

void	addSearchPath (const std::string &path)
	Add search path. More...

virtual const std::vector < std::string > &	getSearchPaths () const
	Gets the array of search paths. More...

virtual bool	isAbsolutePath (const std::string &path) const
	Checks whether the path is an absolute path. More...

local	isAbsolutePath ( local path)
	Checks whether the path is an absolute path. More...

virtual void	setPopupNotify (bool notify)
	Sets/Gets whether to pop-up a message box when failed to load an image. More...

virtual bool	isPopupNotify ()
const std::unordered_map < std::string, std::string > &	getFullPathCache () const
	Returns the full path cache. More...

Additional Inherited Members
Static Public Member Functions inherited from FileUtils
static FileUtils *	getInstance ()
	Gets the instance of FileUtils. More...

var	getInstance ()
	Gets the instance of FileUtils. More...

local	getInstance ()
	Gets the instance of FileUtils. More...

static void	destroyInstance ()
	Destroys the instance of FileUtils. More...

local	destroyInstance ()
	Destroys the instance of FileUtils. More...

static CC_DEPRECATED_ATTRIBUTE FileUtils *	sharedFileUtils ()
local	sharedFileUtils ()
static CC_DEPRECATED_ATTRIBUTE void	purgeFileUtils ()
var	purgeFileUtils ()
local	purgeFileUtils ()
Protected Member Functions inherited from FileUtils
	FileUtils ()
	The default constructor. More...

virtual bool	init ()
	Initializes the instance of FileUtils. More...

local	init ()
	Initializes the instance of FileUtils. More...

virtual std::string	getNewFilename (const std::string &filename)
	Gets the new filename from the filename lookup dictionary. More...

local	getNewFilename ( local filename)
	Gets the new filename from the filename lookup dictionary. More...

virtual std::string	getPathForFilename (const std::string &filename, const std::string &resolutionDirectory, const std::string &searchPath)
	Gets full path for filename, resolution directory and search path. More...

Protected Attributes inherited from FileUtils
ValueMap	_filenameLookupDict
	Dictionary used to lookup filenames based on a key. More...

std::vector< std::string >	_searchResolutionsOrderArray
	The vector contains resolution folders. More...

std::vector< std::string >	_searchPathArray
	The vector contains search paths. More...

std::string	_defaultResRootPath
	The default root path of resources. More...

std::unordered_map < std::string, std::string >	_fullPathCache
	The full path cache. More...

Static Protected Attributes inherited from FileUtils
static FileUtils *	s_sharedFileUtils
	The singleton pointer of FileUtils. More...

var	s_sharedFileUtils
	The singleton pointer of FileUtils. More...

local	s_sharedFileUtils
	The singleton pointer of FileUtils. More...

Detailed Description

Helper class to handle file operations.

Member Function Documentation

virtual std::string getFullPathForDirectoryAndFilename	(	const std::string &	directory,
		const std::string &	filename
	)

overridevirtual

Gets full path for the directory and the filename.

Note: Only iOS and Mac need to override this method since they are using [[NSBundle mainBundle] pathForResource: ofType: inDirectory:] to make a full path. Other platforms will use the default implementation of this method.

Parameters

strDirectory	The directory contains the file we are looking for.
strFilename	The name of the file.

Returns: The full path of the file, if the file can't be found, it will return an empty string.

Reimplemented from FileUtils.

var getFullPathForDirectoryAndFilename	(	var	directory,
		var	filename
	)

overridevirtual

Gets full path for the directory and the filename.

Note: Only iOS and Mac need to override this method since they are using [[NSBundle mainBundle] pathForResource: ofType: inDirectory:] to make a full path. Other platforms will use the default implementation of this method.

Parameters

strDirectory	The directory contains the file we are looking for.
strFilename	The name of the file.

Returns: The full path of the file, if the file can't be found, it will return an empty string.

Reimplemented from FileUtils.

local getFullPathForDirectoryAndFilename	(	local	directory,
		local	filename
	)

overridevirtual

Gets full path for the directory and the filename.

Note: Only iOS and Mac need to override this method since they are using [[NSBundle mainBundle] pathForResource: ofType: inDirectory:] to make a full path. Other platforms will use the default implementation of this method.

Parameters

strDirectory	The directory contains the file we are looking for.
strFilename	The name of the file.

Returns: The full path of the file, if the file can't be found, it will return an empty string.

Reimplemented from FileUtils.

virtual ValueMap
getValueMapFromFile ( const std::string & filename)

overridevirtual

Converts the contents of a file to a ValueMap.

Note: This method is used internally.

Reimplemented from FileUtils.

var getValueMapFromFile ( var filename)

overridevirtual

Converts the contents of a file to a ValueMap.

Note: This method is used internally.

Reimplemented from FileUtils.

local getValueMapFromFile ( local filename)

overridevirtual

Converts the contents of a file to a ValueMap.

Note: This method is used internally.

Reimplemented from FileUtils.

virtual ValueVector
getValueVectorFromFile ( const std::string & filename)

overridevirtual

Converts the contents of a file to a ValueVector.

Note: This method is used internally.

Reimplemented from FileUtils.

var getValueVectorFromFile ( var filename)

overridevirtual

Converts the contents of a file to a ValueVector.

Note: This method is used internally.

Reimplemented from FileUtils.

local getValueVectorFromFile ( local filename)

overridevirtual

Converts the contents of a file to a ValueVector.

Note: This method is used internally.

Reimplemented from FileUtils.

virtual std::string getWritablePath ( ) const

overridevirtual

Gets the writable path.

Returns: The path that can be write/read a file in

Implements FileUtils.

var getWritablePath ( )

overridevirtual

Gets the writable path.

Returns: The path that can be write/read a file in

Implements FileUtils.

local getWritablePath ( )

overridevirtual

Gets the writable path.

Returns: The path that can be write/read a file in

Implements FileUtils.

virtual bool isFileExist ( const std::string & filePath) const

overridevirtual

Checks whether a file exists.

Note: If a relative path was passed in, it will be inserted a default root path at the beginning.

Parameters

strFilePath The path of the file, it could be a relative or absolute path.

Returns: true if the file exists, otherwise it will return false.

Implements FileUtils.

var isFileExist ( var filePath)

overridevirtual

Checks whether a file exists.

Note: If a relative path was passed in, it will be inserted a default root path at the beginning.

Parameters

strFilePath The path of the file, it could be a relative or absolute path.

Returns: true if the file exists, otherwise it will return false.

Implements FileUtils.

local isFileExist ( local filePath)

overridevirtual

Checks whether a file exists.

Note: If a relative path was passed in, it will be inserted a default root path at the beginning.

Parameters

strFilePath The path of the file, it could be a relative or absolute path.

Returns: true if the file exists, otherwise it will return false.

Implements FileUtils.

virtual bool writeToFile	(	ValueMap &	dict,
		const std::string &	fullPath
	)

overridevirtual

Write a ValueMap to a plist file.

Note: This method is used internally.

Reimplemented from FileUtils.

var writeToFile	(	var	dict,
		var	fullPath
	)

overridevirtual

Write a ValueMap to a plist file.

Note: This method is used internally.

Reimplemented from FileUtils.

local writeToFile	(	local	dict,
		local	fullPath
	)

overridevirtual

Write a ValueMap to a plist file.

Note: This method is used internally.

Reimplemented from FileUtils.

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

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos/2d/platform/apple/CCFileUtilsApple.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation