Helper class to handle file operations. More...

#include <CCFileUtils.h>

Inheritance diagram for FileUtils:

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

virtual void	purgeCachedEntries ()
	Purges full path caches. More...

local	purgeCachedEntries ()
	Purges full path caches. 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...

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

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

var	getFileData ( var filename, var mode, var 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...

var	getFileDataFromZip ( var zipFilePath, var filename, var size)
	Gets resource file data from a zip file. More...

local	getFileDataFromZip ( local zipFilePath, local filename, local 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...

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...

var	setFilenameLookupDictionary ( var filenameLookupDict)
	Sets the filenameLookup dictionary. More...

local	setFilenameLookupDictionary ( local 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 relative 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, const bool front=false)
	Append search order of the resources. More...

virtual const std::vector < std::string > &	getSearchResolutionsOrder () const
	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...

void	setDefaultResourceRootPath (const std::string &path)
	Set default resource root path. More...

local	setDefaultResourceRootPath ( local path)
	Set default resource root path. More...

void	addSearchPath (const std::string &path, const bool front=false)
	Add search path. More...

var	addSearchPath ( var path, var false)
	Add search path. More...

local	addSearchPath ( local path, local false)
	Add search path. More...

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

virtual std::string	getWritablePath () const =0
	Gets the writable path. More...

local	getWritablePath ()
	Gets the writable path. More...

virtual void	setWritablePath (const std::string &writablePath)
	Sets writable path. More...

local	setWritablePath ( local writablePath)
	Sets writable path. More...

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

virtual bool	isPopupNotify ()
	Checks whether to pop up a message box when failed to load an image. More...

virtual ValueMap	getValueMapFromFile (const std::string &filename)
	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 ValueMap	getValueMapFromData (const char *filedata, int filesize)
local	getValueMapFromData ( local filedata, local filesize)
virtual bool	writeToFile (ValueMap &dict, const std::string &fullPath)
var	writeToFile ( var dict, var fullPath)
local	writeToFile ( local dict, local fullPath)
virtual ValueVector	getValueVectorFromFile (const std::string &filename)
local	getValueVectorFromFile ( local filename)
virtual bool	isFileExist (const std::string &filename) const
	Checks whether a file exists. More...

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

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

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

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

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

virtual bool	isDirectoryExist (const std::string &dirPath)
	Checks whether the path is a directory. More...

var	isDirectoryExist ( var dirPath)
	Checks whether the path is a directory. More...

local	isDirectoryExist ( local dirPath)
	Checks whether the path is a directory. More...

virtual bool	createDirectory (const std::string &dirPath)
	Creates a directory. More...

var	createDirectory ( var dirPath)
	Creates a directory. More...

local	createDirectory ( local dirPath)
	Creates a directory. More...

virtual bool	removeDirectory (const std::string &dirPath)
	Removes a directory. More...

local	removeDirectory ( local dirPath)
	Removes a directory. More...

virtual bool	removeFile (const std::string &filepath)
	Removes a file. More...

local	removeFile ( local filepath)
	Removes a file. More...

virtual bool	renameFile (const std::string &path, const std::string &oldname, const std::string &name)
	Renames a file under the given directory. More...

local	renameFile ( local path, local oldname, local name)
	Renames a file under the given directory. More...

virtual long	getFileSize (const std::string &filepath)
	Retrieve the file size. More...

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

var	getFullPathCache ()
	Returns the full path cache. More...

local	getFullPathCache ()
	Returns the full path cache. More...

Static Public Member Functions
static FileUtils *	getInstance ()
	Gets the instance of FileUtils. More...

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

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

static void	setDelegate (FileUtils *delegate)
	You can inherit from platform dependent implementation of FileUtils, such as FileUtilsAndroid, and use this function to set delegate, then FileUtils will invoke delegate's implementation. More...

static FileUtils *	sharedFileUtils ()
static void	purgeFileUtils ()

Protected Member Functions
	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) const
	Gets the new filename from the filename lookup dictionary. More...

var	getNewFilename ( var 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 bool	isFileExistInternal (const std::string &filename) const =0
	Checks whether a file exists without considering search paths and resolution orders. More...

virtual bool	isDirectoryExistInternal (const std::string &dirPath) const
	Checks whether a directory exists without considering search paths and resolution orders. More...

var	isDirectoryExistInternal ( var dirPath)
	Checks whether a directory exists without considering search paths and resolution orders. More...

local	isDirectoryExistInternal ( local dirPath)
	Checks whether a directory exists without considering search paths and resolution orders. 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...

var	getPathForFilename ( var filename, var resolutionDirectory, var searchPath)
	Gets full path for filename, resolution directory and search path. More...

local	getPathForFilename ( local filename, local resolutionDirectory, local searchPath)
	Gets full path for filename, resolution directory and search path. More...

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

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

var	searchFullPathForFilename ( var filename)
	Returns the fullpath for a given filename. More...

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

Protected Attributes
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...

var	_searchPathArray
	The vector contains search paths. More...

local	_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...

std::string	_writablePath
	Writable path. More...

var	_writablePath
	Writable path. More...

local	_writablePath
	Writable path. More...

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

Detailed Description

Helper class to handle file operations.

Constructor & Destructor Documentation

virtual ~FileUtils ( )

virtual

The destructor of FileUtils.

FileUtils ( )

protected

The default constructor.

var FileUtils ( )

protected

The default constructor.

local FileUtils ( )

protected

The default constructor.

Member Function Documentation

void addSearchPath	(	const std::string &	path,
		const bool	front = `false`
	)

Add search path.

Since: v2.1

var addSearchPath	(	var	path,
		var	front = `false`
	)

Add search path.

Since: v2.1

local addSearchPath	(	local	path,
		local	front = `false`
	)

Add search path.

Since: v2.1

virtual void addSearchResolutionsOrder	(	const std::string &	order,
		const bool	front = `false`
	)

virtual

Append search order of the resources.

See also: setSearchResolutionsOrder(), fullPathForFilename().

Since: v2.1

var addSearchResolutionsOrder	(	var	order,
		var	front = `false`
	)

virtual

Append search order of the resources.

See also: setSearchResolutionsOrder(), fullPathForFilename().

Since: v2.1

local addSearchResolutionsOrder	(	local	order,
		local	front = `false`
	)

virtual

Append search order of the resources.

See also: setSearchResolutionsOrder(), fullPathForFilename().

Since: v2.1

virtual bool createDirectory ( const std::string & dirPath )

virtual

Creates a directory.

Parameters

dirPath The path of the directory, it must be an absolute path.

Returns: True if the directory have been created successfully, false if not.

var createDirectory ( var dirPath )

virtual

Creates a directory.

Parameters

dirPath The path of the directory, it must be an absolute path.

Returns: True if the directory have been created successfully, false if not.

local createDirectory ( local dirPath )

virtual

Creates a directory.

Parameters

dirPath The path of the directory, it must be an absolute path.

Returns: True if the directory have been created successfully, false if not.

static void destroyInstance ( )

static

Destroys the instance of FileUtils.

var destroyInstance ( )

static

Destroys the instance of FileUtils.

local destroyInstance ( )

static

Destroys the instance of FileUtils.

virtual std::string
fullPathForFilename ( const std::string & filename )

virtual

Returns the fullpath for a given filename.

First it will try to get a new filename from the "filenameLookup" dictionary. If a new filename can't be found on the dictionary, it will use the original filename. Then it will try to obtain the full path of the filename using the FileUtils search rules: resolutions, and search paths. The file search is based on the array element order of search paths and resolution directories.

For instance:

We set two elements("/mnt/sdcard/", "internal_dir/") to search paths vector by setSearchPaths,
and set three elements("resources-ipadhd/", "resources-ipad/", "resources-iphonehd")
to resolutions vector by setSearchResolutionsOrder. The "internal_dir" is relative to "Resources/".

If we have a file named 'sprite.png', the mapping in fileLookup dictionary contains key: sprite.png -> value: sprite.pvr.gz. Firstly, it will replace 'sprite.png' with 'sprite.pvr.gz', then searching the file sprite.pvr.gz as follows:

/mnt/sdcard/resources-ipadhd/sprite.pvr.gz      (if not found, search next)
/mnt/sdcard/resources-ipad/sprite.pvr.gz        (if not found, search next)
/mnt/sdcard/resources-iphonehd/sprite.pvr.gz    (if not found, search next)
/mnt/sdcard/sprite.pvr.gz                       (if not found, search next)
internal_dir/resources-ipadhd/sprite.pvr.gz     (if not found, search next)
internal_dir/resources-ipad/sprite.pvr.gz       (if not found, search next)
internal_dir/resources-iphonehd/sprite.pvr.gz   (if not found, search next)
internal_dir/sprite.pvr.gz                      (if not found, return "sprite.png")

If the filename contains relative path like "gamescene/uilayer/sprite.png", and the mapping in fileLookup dictionary contains key: gamescene/uilayer/sprite.png -> value: gamescene/uilayer/sprite.pvr.gz. The file search order will be:

 /mnt/sdcard/gamescene/uilayer/resources-ipadhd/sprite.pvr.gz      (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/resources-ipad/sprite.pvr.gz        (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/resources-iphonehd/sprite.pvr.gz    (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/sprite.pvr.gz                       (if not found, search next)
 internal_dir/gamescene/uilayer/resources-ipadhd/sprite.pvr.gz     (if not found, search next)
 internal_dir/gamescene/uilayer/resources-ipad/sprite.pvr.gz       (if not found, search next)
 internal_dir/gamescene/uilayer/resources-iphonehd/sprite.pvr.gz   (if not found, search next)
 internal_dir/gamescene/uilayer/sprite.pvr.gz                      (if not found, return "gamescene/uilayer/sprite.png")

If the new file can't be found on the file system, it will return the parameter filename directly.

This method was added to simplify multiplatform support. Whether you are using cocos2d-js or any cross-compilation toolchain like StellaSDK or Apportable, you might need to load different resources for a given file in the different platforms.

Since: v2.1

var fullPathForFilename ( var filename )

virtual

Returns the fullpath for a given filename.

First it will try to get a new filename from the "filenameLookup" dictionary. If a new filename can't be found on the dictionary, it will use the original filename. Then it will try to obtain the full path of the filename using the FileUtils search rules: resolutions, and search paths. The file search is based on the array element order of search paths and resolution directories.

For instance:

We set two elements("/mnt/sdcard/", "internal_dir/") to search paths vector by setSearchPaths,
and set three elements("resources-ipadhd/", "resources-ipad/", "resources-iphonehd")
to resolutions vector by setSearchResolutionsOrder. The "internal_dir" is relative to "Resources/".

If we have a file named 'sprite.png', the mapping in fileLookup dictionary contains key: sprite.png -> value: sprite.pvr.gz. Firstly, it will replace 'sprite.png' with 'sprite.pvr.gz', then searching the file sprite.pvr.gz as follows:

/mnt/sdcard/resources-ipadhd/sprite.pvr.gz      (if not found, search next)
/mnt/sdcard/resources-ipad/sprite.pvr.gz        (if not found, search next)
/mnt/sdcard/resources-iphonehd/sprite.pvr.gz    (if not found, search next)
/mnt/sdcard/sprite.pvr.gz                       (if not found, search next)
internal_dir/resources-ipadhd/sprite.pvr.gz     (if not found, search next)
internal_dir/resources-ipad/sprite.pvr.gz       (if not found, search next)
internal_dir/resources-iphonehd/sprite.pvr.gz   (if not found, search next)
internal_dir/sprite.pvr.gz                      (if not found, return "sprite.png")

If the filename contains relative path like "gamescene/uilayer/sprite.png", and the mapping in fileLookup dictionary contains key: gamescene/uilayer/sprite.png -> value: gamescene/uilayer/sprite.pvr.gz. The file search order will be:

 /mnt/sdcard/gamescene/uilayer/resources-ipadhd/sprite.pvr.gz      (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/resources-ipad/sprite.pvr.gz        (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/resources-iphonehd/sprite.pvr.gz    (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/sprite.pvr.gz                       (if not found, search next)
 internal_dir/gamescene/uilayer/resources-ipadhd/sprite.pvr.gz     (if not found, search next)
 internal_dir/gamescene/uilayer/resources-ipad/sprite.pvr.gz       (if not found, search next)
 internal_dir/gamescene/uilayer/resources-iphonehd/sprite.pvr.gz   (if not found, search next)
 internal_dir/gamescene/uilayer/sprite.pvr.gz                      (if not found, return "gamescene/uilayer/sprite.png")

If the new file can't be found on the file system, it will return the parameter filename directly.

This method was added to simplify multiplatform support. Whether you are using cocos2d-js or any cross-compilation toolchain like StellaSDK or Apportable, you might need to load different resources for a given file in the different platforms.

Since: v2.1

local fullPathForFilename ( local filename )

virtual

Returns the fullpath for a given filename.

First it will try to get a new filename from the "filenameLookup" dictionary. If a new filename can't be found on the dictionary, it will use the original filename. Then it will try to obtain the full path of the filename using the FileUtils search rules: resolutions, and search paths. The file search is based on the array element order of search paths and resolution directories.

For instance:

We set two elements("/mnt/sdcard/", "internal_dir/") to search paths vector by setSearchPaths,
and set three elements("resources-ipadhd/", "resources-ipad/", "resources-iphonehd")
to resolutions vector by setSearchResolutionsOrder. The "internal_dir" is relative to "Resources/".

If we have a file named 'sprite.png', the mapping in fileLookup dictionary contains key: sprite.png -> value: sprite.pvr.gz. Firstly, it will replace 'sprite.png' with 'sprite.pvr.gz', then searching the file sprite.pvr.gz as follows:

/mnt/sdcard/resources-ipadhd/sprite.pvr.gz      (if not found, search next)
/mnt/sdcard/resources-ipad/sprite.pvr.gz        (if not found, search next)
/mnt/sdcard/resources-iphonehd/sprite.pvr.gz    (if not found, search next)
/mnt/sdcard/sprite.pvr.gz                       (if not found, search next)
internal_dir/resources-ipadhd/sprite.pvr.gz     (if not found, search next)
internal_dir/resources-ipad/sprite.pvr.gz       (if not found, search next)
internal_dir/resources-iphonehd/sprite.pvr.gz   (if not found, search next)
internal_dir/sprite.pvr.gz                      (if not found, return "sprite.png")

If the filename contains relative path like "gamescene/uilayer/sprite.png", and the mapping in fileLookup dictionary contains key: gamescene/uilayer/sprite.png -> value: gamescene/uilayer/sprite.pvr.gz. The file search order will be:

 /mnt/sdcard/gamescene/uilayer/resources-ipadhd/sprite.pvr.gz      (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/resources-ipad/sprite.pvr.gz        (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/resources-iphonehd/sprite.pvr.gz    (if not found, search next)
 /mnt/sdcard/gamescene/uilayer/sprite.pvr.gz                       (if not found, search next)
 internal_dir/gamescene/uilayer/resources-ipadhd/sprite.pvr.gz     (if not found, search next)
 internal_dir/gamescene/uilayer/resources-ipad/sprite.pvr.gz       (if not found, search next)
 internal_dir/gamescene/uilayer/resources-iphonehd/sprite.pvr.gz   (if not found, search next)
 internal_dir/gamescene/uilayer/sprite.pvr.gz                      (if not found, return "gamescene/uilayer/sprite.png")

If the new file can't be found on the file system, it will return the parameter filename directly.

This method was added to simplify multiplatform support. Whether you are using cocos2d-js or any cross-compilation toolchain like StellaSDK or Apportable, you might need to load different resources for a given file in the different platforms.

Since: v2.1

virtual std::string fullPathFromRelativeFile	(	const std::string &	filename,
		const std::string &	relativeFile
	)

virtual

Gets full path from a file name and the path of the relative file.

Parameters

filename	The file name.
pszRelativeFile	The path of the relative file.

Returns: The full path. e.g. filename: hello.png, pszRelativeFile: /User/path1/path2/hello.plist Return: /User/path1/path2/hello.pvr (If there a a key(hello.png)-value(hello.pvr) in FilenameLookup dictionary. )

var fullPathFromRelativeFile	(	var	filename,
		var	relativeFile
	)

virtual

Gets full path from a file name and the path of the relative file.

Parameters

filename	The file name.
pszRelativeFile	The path of the relative file.

Returns: The full path. e.g. filename: hello.png, pszRelativeFile: /User/path1/path2/hello.plist Return: /User/path1/path2/hello.pvr (If there a a key(hello.png)-value(hello.pvr) in FilenameLookup dictionary. )

local fullPathFromRelativeFile	(	local	filename,
		local	relativeFile
	)

virtual

Gets full path from a file name and the path of the relative file.

Parameters

filename	The file name.
pszRelativeFile	The path of the relative file.

Returns: The full path. e.g. filename: hello.png, pszRelativeFile: /User/path1/path2/hello.plist Return: /User/path1/path2/hello.pvr (If there a a key(hello.png)-value(hello.pvr) in FilenameLookup dictionary. )

virtual Data getDataFromFile ( const std::string & filename )

virtual

Creates binary data from a file.

Returns: A data object.

Reimplemented in FileUtilsAndroid, and FileUtilsWin32.

var getDataFromFile ( var filename )

virtual

Creates binary data from a file.

Returns: A data object.

Reimplemented in FileUtilsAndroid, and FileUtilsWin32.

local getDataFromFile ( local filename )

virtual

Creates binary data from a file.

Returns: A data object.

Reimplemented in FileUtilsAndroid, and FileUtilsWin32.

virtual unsigned char* getFileData	(	const std::string &	filename,
		const char *	mode,
		ssize_t *	size
	)

virtual

Gets resource file data.

Parameters

[in]	filename	The resource file name which contains the path.
[in]	pszMode	The read mode of the file.
[out]	pSize	If the file read operation succeeds, it will be the data size, otherwise 0.

Returns: Upon success, a pointer to the data is returned, otherwise NULL.

Warning: Recall: you are responsible for calling free() on any Non-NULL pointer returned.

Reimplemented in FileUtilsAndroid, and FileUtilsWin32.

var getFileData	(	var	filename,
		var	mode,
		var	size
	)

virtual

Gets resource file data.

Parameters

[in]	filename	The resource file name which contains the path.
[in]	pszMode	The read mode of the file.
[out]	pSize	If the file read operation succeeds, it will be the data size, otherwise 0.

Returns: Upon success, a pointer to the data is returned, otherwise NULL.

Warning: Recall: you are responsible for calling free() on any Non-NULL pointer returned.

Reimplemented in FileUtilsAndroid, and FileUtilsWin32.

local getFileData	(	local	filename,
		local	mode,
		local	size
	)

virtual

Gets resource file data.

Parameters

[in]	filename	The resource file name which contains the path.
[in]	pszMode	The read mode of the file.
[out]	pSize	If the file read operation succeeds, it will be the data size, otherwise 0.

Returns: Upon success, a pointer to the data is returned, otherwise NULL.

Warning: Recall: you are responsible for calling free() on any Non-NULL pointer returned.

Reimplemented in FileUtilsAndroid, and FileUtilsWin32.

virtual unsigned char* getFileDataFromZip	(	const std::string &	zipFilePath,
		const std::string &	filename,
		ssize_t *	size
	)

virtual

Gets resource file data from a zip file.

Parameters

[in]	filename	The resource file name which contains the relative path of the zip file.
[out]	size	If the file read operation succeeds, it will be the data size, otherwise 0.

Returns: Upon success, a pointer to the data is returned, otherwise nullptr.

Warning: Recall: you are responsible for calling free() on any Non-nullptr pointer returned.

var getFileDataFromZip	(	var	zipFilePath,
		var	filename,
		var	size
	)

virtual

Gets resource file data from a zip file.

Parameters

[in]	filename	The resource file name which contains the relative path of the zip file.
[out]	size	If the file read operation succeeds, it will be the data size, otherwise 0.

Returns: Upon success, a pointer to the data is returned, otherwise nullptr.

Warning: Recall: you are responsible for calling free() on any Non-nullptr pointer returned.

local getFileDataFromZip	(	local	zipFilePath,
		local	filename,
		local	size
	)

virtual

Gets resource file data from a zip file.

Parameters

[in]	filename	The resource file name which contains the relative path of the zip file.
[out]	size	If the file read operation succeeds, it will be the data size, otherwise 0.

Returns: Upon success, a pointer to the data is returned, otherwise nullptr.

Warning: Recall: you are responsible for calling free() on any Non-nullptr pointer returned.

virtual long getFileSize ( const std::string & filepath )

virtual

Retrieve the file size.

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

Parameters

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

Returns: The file size.

var getFileSize ( var filepath )

virtual

Retrieve the file size.

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

Parameters

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

Returns: The file size.

local getFileSize ( local filepath )

virtual

Retrieve the file size.

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

Parameters

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

Returns: The file size.

const std::unordered_map
<std::string, std::string>
& getFullPathCache ( ) const

inline

Returns the full path cache.

var getFullPathCache ( )

inline

Returns the full path cache.

local getFullPathCache ( )

inline

Returns the full path cache.

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

protectedvirtual

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

directory	The directory contains the file we are looking for.
filename	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 in FileUtilsWin32, CCFileUtilsWinRT, and FileUtilsApple.

var getFullPathForDirectoryAndFilename	(	var	directory,
		var	filename
	)

protectedvirtual

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

directory	The directory contains the file we are looking for.
filename	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 in FileUtilsWin32, CCFileUtilsWinRT, and FileUtilsApple.

local getFullPathForDirectoryAndFilename	(	local	directory,
		local	filename
	)

protectedvirtual

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

directory	The directory contains the file we are looking for.
filename	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 in FileUtilsWin32, CCFileUtilsWinRT, and FileUtilsApple.

static FileUtils* getInstance ( )

static

Gets the instance of FileUtils.

var getInstance ( )

static

Gets the instance of FileUtils.

local getInstance ( )

static

Gets the instance of FileUtils.

virtual std::string getNewFilename ( const std::string & filename ) const

protectedvirtual

Gets the new filename from the filename lookup dictionary.

It is possible to have a override names.

Parameters

filename The original filename.

Returns: The new filename after searching in the filename lookup dictionary. If the original filename wasn't in the dictionary, it will return the original filename.

Reimplemented in FileUtilsAndroid.

var getNewFilename ( var filename )

protectedvirtual

Gets the new filename from the filename lookup dictionary.

It is possible to have a override names.

Parameters

filename The original filename.

Returns: The new filename after searching in the filename lookup dictionary. If the original filename wasn't in the dictionary, it will return the original filename.

Reimplemented in FileUtilsAndroid.

local getNewFilename ( local filename )

protectedvirtual

Gets the new filename from the filename lookup dictionary.

It is possible to have a override names.

Parameters

filename The original filename.

Returns: The new filename after searching in the filename lookup dictionary. If the original filename wasn't in the dictionary, it will return the original filename.

Reimplemented in FileUtilsAndroid.

virtual std::string getPathForFilename	(	const std::string &	filename,
		const std::string &	resolutionDirectory,
		const std::string &	searchPath
	)

protectedvirtual

Gets full path for filename, resolution directory and search path.

Parameters

filename	The file name.
resolutionDirectory	The resolution directory.
searchPath	The search path.

Returns: The full path of the file. It will return an empty string if the full path of the file doesn't exist.

Reimplemented in FileUtilsWin32, and CCFileUtilsWinRT.

var getPathForFilename	(	var	filename,
		var	resolutionDirectory,
		var	searchPath
	)

protectedvirtual

Gets full path for filename, resolution directory and search path.

Parameters

filename	The file name.
resolutionDirectory	The resolution directory.
searchPath	The search path.

Returns: The full path of the file. It will return an empty string if the full path of the file doesn't exist.

Reimplemented in FileUtilsWin32, and CCFileUtilsWinRT.

local getPathForFilename	(	local	filename,
		local	resolutionDirectory,
		local	searchPath
	)

protectedvirtual

Gets full path for filename, resolution directory and search path.

Parameters

filename	The file name.
resolutionDirectory	The resolution directory.
searchPath	The search path.

Returns: The full path of the file. It will return an empty string if the full path of the file doesn't exist.

Reimplemented in FileUtilsWin32, and CCFileUtilsWinRT.

virtual const std::vector
<std::string>& getSearchPaths ( ) const

virtual

Gets the array of search paths.

Returns: The array of search paths.

See also: fullPathForFilename(const char*).

var getSearchPaths ( )

virtual

Gets the array of search paths.

Returns: The array of search paths.

See also: fullPathForFilename(const char*).

virtual const std::vector
<std::string>
& getSearchResolutionsOrder ( ) const

virtual

Gets the array that contains the search order of the resources.

See also: setSearchResolutionsOrder(const std::vector<std::string>&), fullPathForFilename(const char*).

Since: v2.1

var getSearchResolutionsOrder ( )

virtual

Gets the array that contains the search order of the resources.

See also: setSearchResolutionsOrder(const std::vector<std::string>&), fullPathForFilename(const char*).

Since: v2.1

virtual std::string
getStringFromFile ( const std::string & filename )

virtual

Gets string from a file.

Reimplemented in FileUtilsAndroid, FileUtilsWin32, and CCFileUtilsWinRT.

var getStringFromFile ( var filename )

virtual

Gets string from a file.

Reimplemented in FileUtilsAndroid, FileUtilsWin32, and CCFileUtilsWinRT.

local getStringFromFile ( local filename )

virtual

Gets string from a file.

Reimplemented in FileUtilsAndroid, FileUtilsWin32, and CCFileUtilsWinRT.

virtual ValueMap getValueMapFromData	(	const char *	filedata,
		int	filesize
	)

virtual

Reimplemented in FileUtilsApple.

var getValueMapFromData	(	var	filedata,
		var	filesize
	)

virtual

Reimplemented in FileUtilsApple.

local getValueMapFromData	(	local	filedata,
		local	filesize
	)

virtual

Reimplemented in FileUtilsApple.

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

virtual

Converts the contents of a file to a ValueMap.

Parameters

filename The filename of the file to gets content.

Returns: ValueMap of the file contents.

Note: This method is used internally.

Reimplemented in FileUtilsApple.

var getValueMapFromFile ( var filename )

virtual

Converts the contents of a file to a ValueMap.

Parameters

filename The filename of the file to gets content.

Returns: ValueMap of the file contents.

Note: This method is used internally.

Reimplemented in FileUtilsApple.

local getValueMapFromFile ( local filename )

virtual

Converts the contents of a file to a ValueMap.

Parameters

filename The filename of the file to gets content.

Returns: ValueMap of the file contents.

Note: This method is used internally.

Reimplemented in FileUtilsApple.

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

virtual

Reimplemented in FileUtilsApple.

var getValueVectorFromFile ( var filename )

virtual

Reimplemented in FileUtilsApple.

local getValueVectorFromFile ( local filename )

virtual

Reimplemented in FileUtilsApple.

virtual std::string getWritablePath ( ) const

pure virtual

Gets the writable path.

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

Implemented in FileUtilsAndroid, FileUtilsLinux, FileUtilsWin32, CCFileUtilsWinRT, and FileUtilsApple.

var getWritablePath ( )

pure virtual

Gets the writable path.

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

Implemented in FileUtilsAndroid, FileUtilsLinux, FileUtilsWin32, CCFileUtilsWinRT, and FileUtilsApple.

local getWritablePath ( )

pure virtual

Gets the writable path.

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

Implemented in FileUtilsAndroid, FileUtilsLinux, FileUtilsWin32, CCFileUtilsWinRT, and FileUtilsApple.

virtual bool init ( )

protectedvirtual

Initializes the instance of FileUtils.

It will set _searchPathArray and _searchResolutionsOrderArray to default values.

Note: When you are porting Cocos2d-x to a new platform, you may need to take care of this method. You could assign a default value to _defaultResRootPath in the subclass of FileUtils(e.g. FileUtilsAndroid). Then invoke the FileUtils::init().

Returns: true if successed, otherwise it returns false.

Reimplemented in FileUtilsAndroid, FileUtilsLinux, FileUtilsWin32, and CCFileUtilsWinRT.

var init ( )

protectedvirtual

Initializes the instance of FileUtils.

It will set _searchPathArray and _searchResolutionsOrderArray to default values.

Note: When you are porting Cocos2d-x to a new platform, you may need to take care of this method. You could assign a default value to _defaultResRootPath in the subclass of FileUtils(e.g. FileUtilsAndroid). Then invoke the FileUtils::init().

Returns: true if successed, otherwise it returns false.

Reimplemented in FileUtilsAndroid, FileUtilsLinux, FileUtilsWin32, and CCFileUtilsWinRT.

local init ( )

protectedvirtual

Initializes the instance of FileUtils.

It will set _searchPathArray and _searchResolutionsOrderArray to default values.

Note: When you are porting Cocos2d-x to a new platform, you may need to take care of this method. You could assign a default value to _defaultResRootPath in the subclass of FileUtils(e.g. FileUtilsAndroid). Then invoke the FileUtils::init().

Returns: true if successed, otherwise it returns false.

Reimplemented in FileUtilsAndroid, FileUtilsLinux, FileUtilsWin32, and CCFileUtilsWinRT.

virtual bool isAbsolutePath ( const std::string & path ) const

virtual

Checks whether the path is an absolute path.

Note: On Android, if the parameter passed in is relative to "assets/", this method will treat it as an absolute path. Also on Blackberry, path starts with "app/native/Resources/" is treated as an absolute path.

Parameters

path	The path that needs to be checked.

Returns: True if it's an absolute path, false if not.

Reimplemented in FileUtilsAndroid, FileUtilsWin32, and CCFileUtilsWinRT.

var isAbsolutePath ( var path )

virtual

Checks whether the path is an absolute path.

Note: On Android, if the parameter passed in is relative to "assets/", this method will treat it as an absolute path. Also on Blackberry, path starts with "app/native/Resources/" is treated as an absolute path.

Parameters

path	The path that needs to be checked.

Returns: True if it's an absolute path, false if not.

Reimplemented in FileUtilsAndroid, FileUtilsWin32, and CCFileUtilsWinRT.

local isAbsolutePath ( local path )

virtual

Checks whether the path is an absolute path.

Note: On Android, if the parameter passed in is relative to "assets/", this method will treat it as an absolute path. Also on Blackberry, path starts with "app/native/Resources/" is treated as an absolute path.

Parameters

path	The path that needs to be checked.

Returns: True if it's an absolute path, false if not.

Reimplemented in FileUtilsAndroid, FileUtilsWin32, and CCFileUtilsWinRT.

virtual bool isDirectoryExist ( const std::string & dirPath )

virtual

Checks whether the path is a directory.

Parameters

dirPath The path of the directory, it could be a relative or an absolute path.

Returns: True if the directory exists, false if not.

var isDirectoryExist ( var dirPath )

virtual

Checks whether the path is a directory.

Parameters

dirPath The path of the directory, it could be a relative or an absolute path.

Returns: True if the directory exists, false if not.

local isDirectoryExist ( local dirPath )

virtual

Checks whether the path is a directory.

Parameters

dirPath The path of the directory, it could be a relative or an absolute path.

Returns: True if the directory exists, false if not.

virtual bool
isDirectoryExistInternal ( const std::string & dirPath ) const

protectedvirtual

Checks whether a directory exists without considering search paths and resolution orders.

Parameters

dirPath The directory (with absolute path) to look up for

Returns: Returns true if the directory found at the given absolute path, otherwise returns false

var isDirectoryExistInternal ( var dirPath )

protectedvirtual

Checks whether a directory exists without considering search paths and resolution orders.

Parameters

dirPath The directory (with absolute path) to look up for

Returns: Returns true if the directory found at the given absolute path, otherwise returns false

local isDirectoryExistInternal ( local dirPath )

protectedvirtual

Checks whether a directory exists without considering search paths and resolution orders.

Parameters

dirPath The directory (with absolute path) to look up for

Returns: Returns true if the directory found at the given absolute path, otherwise returns false

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

virtual

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

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

Returns: True if the file exists, false if not.

var isFileExist ( var filename )

virtual

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

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

Returns: True if the file exists, false if not.

local isFileExist ( local filename )

virtual

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

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

Returns: True if the file exists, false if not.

virtual bool isFileExistInternal ( const std::string & filename ) const

protectedpure virtual

Checks whether a file exists without considering search paths and resolution orders.

Parameters

filename The file (with absolute path) to look up for

Returns: Returns true if the file found at the given absolute path, otherwise returns false

Implemented in FileUtilsWin32.

var isFileExistInternal ( var filename )

protectedpure virtual

Checks whether a file exists without considering search paths and resolution orders.

Parameters

filename The file (with absolute path) to look up for

Returns: Returns true if the file found at the given absolute path, otherwise returns false

Implemented in FileUtilsWin32.

local isFileExistInternal ( local filename )

protectedpure virtual

Checks whether a file exists without considering search paths and resolution orders.

Parameters

filename The file (with absolute path) to look up for

Returns: Returns true if the file found at the given absolute path, otherwise returns false

Implemented in FileUtilsWin32.

virtual bool isPopupNotify ( )

virtual

Checks whether to pop up a message box when failed to load an image.

Returns: True if pop up a message box when failed to load an image, false if not.

var isPopupNotify ( )

virtual

Checks whether to pop up a message box when failed to load an image.

Returns: True if pop up a message box when failed to load an image, false if not.

local isPopupNotify ( )

virtual

Checks whether to pop up a message box when failed to load an image.

Returns: True if pop up a message box when failed to load an image, false if not.

virtual void
loadFilenameLookupDictionaryFromFile ( const std::string & filename )

virtual

Loads the filenameLookup dictionary from the contents of a filename.

Note: The plist file name should follow the format below:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>filenames</key>
    <dict>
        <key>sounds/click.wav</key>
        <string>sounds/click.caf</string>
        <key>sounds/endgame.wav</key>
        <string>sounds/endgame.caf</string>
        <key>sounds/gem-0.wav</key>
        <string>sounds/gem-0.caf</string>
    </dict>
    <key>metadata</key>
    <dict>
        <key>version</key>
        <integer>1</integer>
    </dict>
</dict>
</plist>

Parameters

filename The plist file name.

Since: v2.1

var loadFilenameLookup ( var filename )

virtual

Loads the filenameLookup dictionary from the contents of a filename.

Note: The plist file name should follow the format below:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>filenames</key>
    <dict>
        <key>sounds/click.wav</key>
        <string>sounds/click.caf</string>
        <key>sounds/endgame.wav</key>
        <string>sounds/endgame.caf</string>
        <key>sounds/gem-0.wav</key>
        <string>sounds/gem-0.caf</string>
    </dict>
    <key>metadata</key>
    <dict>
        <key>version</key>
        <integer>1</integer>
    </dict>
</dict>
</plist>

Parameters

filename The plist file name.

Since: v2.1

local loadFilenameLookup ( local filename )

virtual

Loads the filenameLookup dictionary from the contents of a filename.

Note: The plist file name should follow the format below:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>filenames</key>
    <dict>
        <key>sounds/click.wav</key>
        <string>sounds/click.caf</string>
        <key>sounds/endgame.wav</key>
        <string>sounds/endgame.caf</string>
        <key>sounds/gem-0.wav</key>
        <string>sounds/gem-0.caf</string>
    </dict>
    <key>metadata</key>
    <dict>
        <key>version</key>
        <integer>1</integer>
    </dict>
</dict>
</plist>

Parameters

filename The plist file name.

Since: v2.1

virtual void purgeCachedEntries ( )

virtual

Purges full path caches.

var purgeCachedEntries ( )

virtual

Purges full path caches.

local purgeCachedEntries ( )

virtual

Purges full path caches.

static void purgeFileUtils ( )

inlinestatic

Deprecated:: Use destroyInstance() instead

var purgeFileUtils ( )

inlinestatic

Deprecated:: Use destroyInstance() instead

local purgeFileUtils ( )

inlinestatic

Deprecated:: Use destroyInstance() instead

virtual bool removeDirectory ( const std::string & dirPath )

virtual

Removes a directory.

Parameters

dirPath The full path of the directory, it must be an absolute path.

Returns: True if the directory have been removed successfully, false if not.

var removeDirectory ( var dirPath )

virtual

Removes a directory.

Parameters

dirPath The full path of the directory, it must be an absolute path.

Returns: True if the directory have been removed successfully, false if not.

local removeDirectory ( local dirPath )

virtual

Removes a directory.

Parameters

dirPath The full path of the directory, it must be an absolute path.

Returns: True if the directory have been removed successfully, false if not.

virtual bool removeFile ( const std::string & filepath )

virtual

Removes a file.

Parameters

filepath The full path of the file, it must be an absolute path.

Returns: True if the file have been removed successfully, false if not.

var removeFile ( var filepath )

virtual

Removes a file.

Parameters

filepath The full path of the file, it must be an absolute path.

Returns: True if the file have been removed successfully, false if not.

local removeFile ( local filepath )

virtual

Removes a file.

Parameters

filepath The full path of the file, it must be an absolute path.

Returns: True if the file have been removed successfully, false if not.

virtual bool renameFile	(	const std::string &	path,
		const std::string &	oldname,
		const std::string &	name
	)

virtual

Renames a file under the given directory.

Parameters

path	The parent directory path of the file, it must be an absolute path.
oldname	The current name of the file.
name	The new name of the file.

Returns: True if the file have been renamed successfully, false if not.

var renameFile	(	var	path,
		var	oldname,
		var	name
	)

virtual

Renames a file under the given directory.

Parameters

path	The parent directory path of the file, it must be an absolute path.
oldname	The current name of the file.
name	The new name of the file.

Returns: True if the file have been renamed successfully, false if not.

local renameFile	(	local	path,
		local	oldname,
		local	name
	)

virtual

Renames a file under the given directory.

Parameters

path	The parent directory path of the file, it must be an absolute path.
oldname	The current name of the file.
name	The new name of the file.

Returns: True if the file have been renamed successfully, false if not.

virtual std::string
searchFullPathForFilename ( const std::string & filename ) const

protectedvirtual

Returns the fullpath for a given filename.

This is an alternative for fullPathForFilename, there are two main differences: First, it returns empty string instead of the original filename when no file found for the given name. Secondly, it's a const function.

Parameters

filename The file name to look up for

Returns: The full path for the file, if not found, the return value will be an empty string

var searchFullPathForFilename ( var filename )

protectedvirtual

Returns the fullpath for a given filename.

This is an alternative for fullPathForFilename, there are two main differences: First, it returns empty string instead of the original filename when no file found for the given name. Secondly, it's a const function.

Parameters

filename The file name to look up for

Returns: The full path for the file, if not found, the return value will be an empty string

local searchFullPathForFilename ( local filename )

protectedvirtual

Returns the fullpath for a given filename.

This is an alternative for fullPathForFilename, there are two main differences: First, it returns empty string instead of the original filename when no file found for the given name. Secondly, it's a const function.

Parameters

filename The file name to look up for

Returns: The full path for the file, if not found, the return value will be an empty string

void setDefaultResourceRootPath ( const std::string & path )

Set default resource root path.

var setDefaultResourceRootPath ( var path )

Set default resource root path.

local setDefaultResourceRootPath ( local path )

Set default resource root path.

static void setDelegate ( FileUtils * delegate )

static

You can inherit from platform dependent implementation of FileUtils, such as FileUtilsAndroid, and use this function to set delegate, then FileUtils will invoke delegate's implementation.

Fox example, your resources are encrypted, so you need to decrypt it after reading data from resources, then you can implement all getXXX functions, and engine will invoke your own getXX functions when reading data of resources.

If you don't want to system default implementation after setting delegate, you can just pass nullptr to this function.

It will delete previous delegate

var setDelegate ( var delegate )

static

You can inherit from platform dependent implementation of FileUtils, such as FileUtilsAndroid, and use this function to set delegate, then FileUtils will invoke delegate's implementation.

Fox example, your resources are encrypted, so you need to decrypt it after reading data from resources, then you can implement all getXXX functions, and engine will invoke your own getXX functions when reading data of resources.

If you don't want to system default implementation after setting delegate, you can just pass nullptr to this function.

It will delete previous delegate

virtual void
setFilenameLookupDictionary ( const ValueMap & filenameLookupDict )

virtual

Sets the filenameLookup dictionary.

Parameters

pFilenameLookupDict The dictionary for replacing filename.

Since: v2.1

var setFilenameLookupDictionary ( var filenameLookupDict )

virtual

Sets the filenameLookup dictionary.

Parameters

pFilenameLookupDict The dictionary for replacing filename.

Since: v2.1

local setFilenameLookupDictionary ( local filenameLookupDict )

virtual

Sets the filenameLookup dictionary.

Parameters

pFilenameLookupDict The dictionary for replacing filename.

Since: v2.1

virtual void setPopupNotify ( bool notify )

virtual

Sets whether to pop-up a message box when failed to load an image.

var setPopupNotify ( var notify )

virtual

Sets whether to pop-up a message box when failed to load an image.

local setPopupNotify ( local notify )

virtual

Sets whether to pop-up a message box when failed to load an image.

virtual void setSearchPaths ( const std::vector< std::string > & searchPaths )

virtual

Sets the array of search paths.

You can use this array to modify the search path of the resources. If you want to use "themes" or search resources in the "cache", you can do it easily by adding new entries in this array.

Note: This method could access relative path and absolute path. If the relative path was passed to the vector, FileUtils will add the default resource directory before the relative path. For instance: On Android, the default resource root path is "assets/". If "/mnt/sdcard/" and "resources-large" were set to the search paths vector, "resources-large" will be converted to "assets/resources-large" since it was a relative path.

Parameters

searchPaths The array contains search paths.

See also: fullPathForFilename(const char*)

Since: v2.1 In js:var setSearchPaths(var jsval);

var setSearchPaths ( var searchPaths )

virtual

Sets the array of search paths.

You can use this array to modify the search path of the resources. If you want to use "themes" or search resources in the "cache", you can do it easily by adding new entries in this array.

Note: This method could access relative path and absolute path. If the relative path was passed to the vector, FileUtils will add the default resource directory before the relative path. For instance: On Android, the default resource root path is "assets/". If "/mnt/sdcard/" and "resources-large" were set to the search paths vector, "resources-large" will be converted to "assets/resources-large" since it was a relative path.

Parameters

searchPaths The array contains search paths.

See also: fullPathForFilename(const char*)

Since: v2.1 In js:var setSearchPaths(var jsval);

virtual void
setSearchResolutionsOrder ( const std::vector< std::string > & searchResolutionsOrder )

virtual

Sets the array that contains the search order of the resources.

Parameters

searchResolutionsOrder The source array that contains the search order of the resources.

See also: getSearchResolutionsOrder(), fullPathForFilename(const char*).

Since: v2.1 In js:var setSearchResolutionsOrder(var jsval)

var setSearchResolutionsOrder ( var searchResolutionsOrder )

virtual

Sets the array that contains the search order of the resources.

Parameters

searchResolutionsOrder The source array that contains the search order of the resources.

See also: getSearchResolutionsOrder(), fullPathForFilename(const char*).

Since: v2.1 In js:var setSearchResolutionsOrder(var jsval)

virtual void setWritablePath ( const std::string & writablePath )

virtual

Sets writable path.

var setWritablePath ( var writablePath )

virtual

Sets writable path.

local setWritablePath ( local writablePath )

virtual

Sets writable path.

static FileUtils* sharedFileUtils ( )

inlinestatic

Deprecated:: Use getInstance() instead

var sharedFileUtils ( )

inlinestatic

Deprecated:: Use getInstance() instead

local sharedFileUtils ( )

inlinestatic

Deprecated:: Use getInstance() instead

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

virtual

Reimplemented in FileUtilsApple.

var writeToFile	(	var	dict,
		var	fullPath
	)

virtual

Reimplemented in FileUtilsApple.

local writeToFile	(	local	dict,
		local	fullPath
	)

virtual

Reimplemented in FileUtilsApple.

Member Data Documentation

std::string _defaultResRootPath

protected

The default root path of resources.

If the default root path of resources needs to be changed, do it in the init method of FileUtils's subclass. For instance: On Android, the default root path of resources will be assigned with "assets/" in FileUtilsAndroid::init(). Similarly on Blackberry, we assign "app/native/Resources/" to this variable in FileUtilsBlackberry::init().

var _defaultResRootPath

protected

The default root path of resources.

If the default root path of resources needs to be changed, do it in the init method of FileUtils's subclass. For instance: On Android, the default root path of resources will be assigned with "assets/" in FileUtilsAndroid::init(). Similarly on Blackberry, we assign "app/native/Resources/" to this variable in FileUtilsBlackberry::init().

local _defaultResRootPath

protected

The default root path of resources.

If the default root path of resources needs to be changed, do it in the init method of FileUtils's subclass. For instance: On Android, the default root path of resources will be assigned with "assets/" in FileUtilsAndroid::init(). Similarly on Blackberry, we assign "app/native/Resources/" to this variable in FileUtilsBlackberry::init().

ValueMap _filenameLookupDict

protected

Dictionary used to lookup filenames based on a key.

It is used internally by the following methods:

std::string fullPathForFilename(const char*);

Since: v2.1

std::unordered_map<std::string,
std::string> _fullPathCache

protected

The full path cache.

When a file is found, it will be added into this cache. This variable is used for improving the performance of file search.

var _fullPathCache

protected

The full path cache.

When a file is found, it will be added into this cache. This variable is used for improving the performance of file search.

local _fullPathCache

protected

The full path cache.

When a file is found, it will be added into this cache. This variable is used for improving the performance of file search.

std::vector<std::string>
_searchPathArray

protected

The vector contains search paths.

The lower index of the element in this vector, the higher priority for this search path.

var _searchPathArray

protected

The vector contains search paths.

The lower index of the element in this vector, the higher priority for this search path.

local _searchPathArray

protected

The vector contains search paths.

The lower index of the element in this vector, the higher priority for this search path.

std::vector<std::string>
_searchResolutionsOrderArray

protected

The vector contains resolution folders.

The lower index of the element in this vector, the higher priority for this resolution directory.

var _searchResolutionsOrderArray

protected

The vector contains resolution folders.

The lower index of the element in this vector, the higher priority for this resolution directory.

local _searchResolutionsOrderArray

protected

The vector contains resolution folders.

The lower index of the element in this vector, the higher priority for this resolution directory.

std::string _writablePath

protected

Writable path.

var _writablePath

protected

Writable path.

local _writablePath

protected

Writable path.

FileUtils* s_sharedFileUtils

staticprotected

The singleton pointer of FileUtils.

var s_sharedFileUtils

staticprotected

The singleton pointer of FileUtils.

local s_sharedFileUtils

staticprotected

The singleton pointer of FileUtils.

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

/Users/minggo/SourceCode/cocos2d-x/cocos/platform/CCFileUtils.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation