Helper class to handle file operations. More...

#include <CCFileUtils-android.h>

Inheritance diagram for FileUtilsAndroid:

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

virtual std::string	getNewFilename (const std::string &filename) const override
	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 unsigned char *	getFileData (const std::string &filename, const char mode, ssize_t size) override
local	getFileData ( local filename, local mode, local size)
virtual std::string	getStringFromFile (const std::string &filename) override
	Gets string from a file. More...

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

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

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

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

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

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

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

local	purgeCachedEntries ()
	Purges full path caches. 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 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	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 void	setassetmanager (AAssetManager *a)
static AAssetManager *	getAssetManager ()
local	getAssetManager ()
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...

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 ()

Friends
class	FileUtils

Additional Inherited Members
Protected Member Functions inherited from FileUtils
	FileUtils ()
	The default constructor. 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 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...

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 inherited from FileUtils
static FileUtils *	s_sharedFileUtils
	The singleton pointer of FileUtils. More...

Detailed Description

Helper class to handle file operations.

Constructor & Destructor Documentation

FileUtilsAndroid ( )

var FileUtilsAndroid ( )

local FileUtilsAndroid ( )

virtual ~FileUtilsAndroid ( )

virtual

Member Function Documentation

static AAssetManager*
getAssetManager ( )

inlinestatic

var getAssetManager ( )

inlinestatic

local getAssetManager ( )

inlinestatic

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

overridevirtual

Creates binary data from a file.

Returns: A data object.

Reimplemented from FileUtils.

var getDataFromFile ( var filename )

overridevirtual

Creates binary data from a file.

Returns: A data object.

Reimplemented from FileUtils.

local getDataFromFile ( local filename )

overridevirtual

Creates binary data from a file.

Returns: A data object.

Reimplemented from FileUtils.

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

overridevirtual

Deprecated:: Please use FileUtils::getDataFromFile or FileUtils::getStringFromFile instead.

Reimplemented from FileUtils.

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

overridevirtual

Deprecated:: Please use FileUtils::getDataFromFile or FileUtils::getStringFromFile instead.

Reimplemented from FileUtils.

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

overridevirtual

Deprecated:: Please use FileUtils::getDataFromFile or FileUtils::getStringFromFile instead.

Reimplemented from FileUtils.

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

overridevirtual

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

var getNewFilename ( var filename )

overridevirtual

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

local getNewFilename ( local filename )

overridevirtual

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

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

overridevirtual

Gets string from a file.

Reimplemented from FileUtils.

var getStringFromFile ( var filename )

overridevirtual

Gets string from a file.

Reimplemented from FileUtils.

local getStringFromFile ( local filename )

overridevirtual

Gets string from a file.

Reimplemented from FileUtils.

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

path	The path that needs to be checked.

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

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

path	The path that needs to be checked.

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

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

path	The path that needs to be checked.

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

Reimplemented from 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/minggo/SourceCode/cocos2d-x/cocos/platform/android/CCFileUtils-android.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