Helper class to handle file operations. More...

#include <CCFileUtilsAndroid.h>

Inheritance diagram for FileUtilsAndroid:

Public Member Functions
virtual	~FileUtilsAndroid ()
bool	init ()
	Initializes the instance of FileUtils. More...

virtual unsigned char *	getFileData (const char filename, const char pszMode, unsigned long *pSize)
	Gets resource file data. More...

var	getFileData ( var filename, var pszMode, var pSize)
	Gets resource file data. More...

local	getFileData ( local filename, local pszMode, local pSize)
	Gets resource file data. More...

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

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

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

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

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

unsigned char *	getFileDataForAsync (const char filename, const char pszMode, unsigned long *pSize)
	This function is android specific. More...

local	getFileDataForAsync ( local filename, local pszMode, local pSize)
	This function is android specific. More...

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

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

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

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

virtual unsigned char *	getFileDataFromZip (const char zipFilePath, const char filename, unsigned long *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...

var	loadFilenameLookup ( var filename)
	Loads the filenameLookup dictionary from the contents of a filename. More...

local	loadFilenameLookup ( local filename)
	Loads the filenameLookup dictionary from the contents of a filename. More...

virtual void	setFilenameLookupDictionary (Dictionary *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...

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

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

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

virtual const std::vector < std::string > &	getSearchPaths () const
	Gets the array of search paths. 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 ()

Static Public Member Functions
static void	setassetmanager (AAssetManager *a)
local	setassetmanager ( local a)
Static Public Member Functions inherited from FileUtils
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...

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

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

static FileUtils *	sharedFileUtils ()
local	sharedFileUtils ()
static void	purgeFileUtils ()
var	purgeFileUtils ()
local	purgeFileUtils ()

Friends
class	FileUtils

Additional Inherited Members
Protected Member Functions inherited from FileUtils
	FileUtils ()
	The default constructor. More...

	FileUtils ()
	The default constructor. More...

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

virtual std::string	getFullPathForDirectoryAndFilename (const std::string &directory, const std::string &filename)
	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 Dictionary *	createDictionaryWithContentsOfFile (const std::string &filename)
	Creates a dictionary by the contents of a file. More...

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

var	writeToFile ( var dict, var fullPath)
	Write a dictionary to a plist file. More...

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

virtual Array *	createArrayWithContentsOfFile (const std::string &filename)
	Creates an array by the contents of a file. More...

Protected Attributes inherited from FileUtils
Dictionary *	_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::map< std::string, std::string >	_fullPathCache
	The full path cache. More...

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

Constructor & Destructor Documentation

virtual ~FileUtilsAndroid ( )

virtual

Member Function Documentation

virtual unsigned char* getFileData	(	const char *	filename,
		const char *	mode,
		unsigned long *	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 delete[] on any Non-NULL pointer returned.

Reimplemented from FileUtils.

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 delete[] on any Non-NULL pointer returned.

Reimplemented from FileUtils.

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 delete[] on any Non-NULL pointer returned.

Reimplemented from FileUtils.

unsigned char* getFileDataForAsync	(	const char *	filename,
		const char *	pszMode,
		unsigned long *	pSize
	)

This function is android specific.

It is used for TextureCache::addImageAsync(). Don't use it in your codes.

var getFileDataForAsync	(	var	filename,
		var	pszMode,
		var	pSize
	)

This function is android specific.

It is used for TextureCache::addImageAsync(). Don't use it in your codes.

local getFileDataForAsync	(	local	filename,
		local	pszMode,
		local	pSize
	)

This function is android specific.

It is used for TextureCache::addImageAsync(). Don't use it in your codes.

virtual std::string getWritablePath ( ) const

virtual

Gets the writable path.

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

Implements FileUtils.

var getWritablePath ( )

virtual

Gets the writable path.

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

Implements FileUtils.

local getWritablePath ( )

virtual

Gets the writable path.

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

Implements FileUtils.

bool init ( )

virtual

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

var init ( )

virtual

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

local init ( )

virtual

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

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

strPath The path that needs to be checked.

Returns: true if it's an absolute path, otherwise it will return false.

Reimplemented from FileUtils.

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

strPath The path that needs to be checked.

Returns: true if it's an absolute path, otherwise it will return false.

Reimplemented from FileUtils.

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

strPath The path that needs to be checked.

Returns: true if it's an absolute path, otherwise it will return false.

Reimplemented from FileUtils.

virtual bool isFileExist ( const std::string & filePath) 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

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)

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

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)

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

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.

static void setassetmanager ( AAssetManager * a)

static

var setassetmanager ( var a)

static

local setassetmanager ( local a)

static

Friends And Related Function Documentation

friend class FileUtils

friend

var FileUtils

friend

local FileUtils

friend

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

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos2dx/platform/android/CCFileUtilsAndroid.h

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation