Helper class to handle file operations. More...

#include <CCFileUtils-android.h>

Inheritance diagram for FileUtilsAndroid:

Public Member Functions
	FileUtilsAndroid ()

virtual	~FileUtilsAndroid ()
	NA NA More...

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

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

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

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

virtual void	purgeCachedEntries ()
	Purges the file searching cache. 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...

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

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	addSearchPath (const std::string &path, const bool front=false)
	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 ()

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

virtual ValueMap	getValueMapFromData (const char *filedata, int filesize)
	Converts the contents of a file to a ValueMap. More...

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

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

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

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

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

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

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

virtual bool	renameFile (const std::string &path, const std::string &oldname, const std::string &name)
	Rename 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...

Static Public Member Functions
static void	setassetmanager (AAssetManager *a)

static AAssetManager *	getAssetManager ()

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

static void	destroyInstance ()
	Destroys the instance of FileUtils. 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...

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

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

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

Detailed Description

Helper class to handle file operations.

Constructor & Destructor Documentation

FileUtilsAndroid ( )

virtual ~FileUtilsAndroid ( )

virtual

NA NA

Member Function Documentation

static AAssetManager* getAssetManager ( )

inlinestatic

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

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.

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

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.

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.

static void setassetmanager ( AAssetManager * a )

static

Friends And Related Function Documentation

friend class FileUtils

friend

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

/Users/huihoo/Software/huihoo-code/cocos2d-x/cocos2d-x-3.3/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