Helper class to handle file operations. More...

Inherits FileUtils.

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

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

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

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

virtual void	purgeCachedEntries ()
	Purges full path caches.

local	purgeCachedEntries ()
	Purges full path caches.

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

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

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

virtual void	getStringFromFile (const std::string &path, std::function< void(std::string)> callback)
	Gets string from a file, async off the main cocos thread. More...

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

virtual void	getDataFromFile (const std::string &filename, std::function< void(Data)> callback)
	Gets a binary data object from a file, async off the main cocos thread. More...

var	getDataFromFile ( var filename, var callback)
	Gets a binary data object from a file, async off the main cocos thread. More...

local	getDataFromFile ( local filename, local callback)
	Gets a binary data object from a file, async off the main cocos thread. More...

template<typename T , typename Enable = typename std::enable_if< std::is_base_of< ResizableBuffer, ResizableBufferAdapter<T> >::value >::type>
Status	getContents (const std::string &filename, T *buffer)
	Gets whole file contents as string from a file. More...

template<typename T , typename Enable = typename std::enable_if< std::is_base_of< ResizableBuffer, ResizableBufferAdapter<T> >::value >::type>
var	getContents ( var filename, var buffer)
	Gets whole file contents as string from a file. More...

template<typename T , typename Enable = typename std::enable_if< std::is_base_of< ResizableBuffer, ResizableBufferAdapter<T> >::value >::type>
local	getContents ( local filename, local buffer)
	Gets whole file contents as string 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...

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

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

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

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

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 (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 relative file. More...

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

local	addSearchResolutionsOrder ( local order, local 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...

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

const std::string &	getDefaultResourceRootPath () const
	Get default resource root path.

local	getDefaultResourceRootPath ()
	Get default resource root path.

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.

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 const std::vector < std::string > &	getOriginalSearchPaths () const
	Gets the original search path array set by 'setSearchPaths' or 'addSearchPath'. More...

local	getOriginalSearchPaths ()
	Gets the original search path array set by 'setSearchPaths' or 'addSearchPath'. More...

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

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

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

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

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

var	getValueMapFromFile ( var 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)
	Converts the contents of a file to a ValueMap. More...

var	getValueMapFromData ( var filedata, var filesize)
	Converts the contents of a file to a ValueMap. More...

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

var	writeToFile ( var dict, var fullPath)
	write a ValueMap into a plist file More...

local	writeToFile ( local dict, local fullPath)
	write a ValueMap into a plist file More...

virtual bool	writeStringToFile (const std::string &dataStr, const std::string &fullPath)
	write a string into a file More...

local	writeStringToFile ( local dataStr, local fullPath)
	write a string into a file More...

virtual void	writeStringToFile (std::string dataStr, const std::string &fullPath, std::function< void(bool)> callback)
	Write a string to a file, done async off the main cocos thread Use this function if you need file access without blocking the main thread. More...

local	writeStringToFile ( local dataStr, local fullPath, local callback)
	Write a string to a file, done async off the main cocos thread Use this function if you need file access without blocking the main thread. More...

virtual bool	writeDataToFile (const Data &data, const std::string &fullPath)
	write Data into a file More...

virtual void	writeDataToFile (Data data, const std::string &fullPath, std::function< void(bool)> callback)
	Write Data into a file, done async off the main cocos thread. More...

var	writeDataToFile ( var data, var fullPath, var callback)
	Write Data into a file, done async off the main cocos thread. More...

local	writeDataToFile ( local data, local fullPath, local callback)
	Write Data into a file, done async off the main cocos thread. More...

virtual bool	writeValueMapToFile (const ValueMap &dict, const std::string &fullPath)
	write ValueMap into a plist file More...

var	writeValueMapToFile ( var dict, var fullPath)
	write ValueMap into a plist file More...

local	writeValueMapToFile ( local dict, local fullPath)
	write ValueMap into a plist file More...

virtual void	writeValueMapToFile (ValueMap dict, const std::string &fullPath, std::function< void(bool)> callback)
	Write a ValueMap into a file, done async off the main cocos thread. More...

var	writeValueMapToFile ( var dict, var fullPath, var callback)
	Write a ValueMap into a file, done async off the main cocos thread. More...

local	writeValueMapToFile ( local dict, local fullPath, local callback)
	Write a ValueMap into a file, done async off the main cocos thread. More...

virtual bool	writeValueVectorToFile (const ValueVector &vecData, const std::string &fullPath)
	write ValueVector into a plist file More...

var	writeValueVectorToFile ( var vecData, var fullPath)
	write ValueVector into a plist file More...

local	writeValueVectorToFile ( local vecData, local fullPath)
	write ValueVector into a plist file More...

virtual void	writeValueVectorToFile (ValueVector vecData, const std::string &fullPath, std::function< void(bool)> callback)
	Write a ValueVector into a file, done async off the main cocos thread. More...

var	writeValueVectorToFile ( var vecData, var fullPath, var callback)
	Write a ValueVector into a file, done async off the main cocos thread. More...

local	writeValueVectorToFile ( local vecData, local fullPath, local callback)
	Write a ValueVector into a file, done async off the main cocos thread. More...

virtual std::string	getSuitableFOpen (const std::string &filenameUtf8) const
	Windows fopen can't support UTF-8 filename Need convert all parameters fopen and other 3rd-party libs. More...

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

virtual void	isFileExist (const std::string &filename, std::function< void(bool)> callback)
	Checks if a file exists, done async off the main cocos thread. More...

virtual std::string	getFileExtension (const std::string &filePath) const
	Gets filename extension is a suffix (separated from the base filename by a dot) in lower case. More...

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

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

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

virtual void	isDirectoryExist (const std::string &fullPath, std::function< void(bool)> callback)
	Checks whether the absoulate path is a directory, async off of the main cocos thread. More...

local	isDirectoryExist ( local fullPath, local callback)
	Checks whether the absoulate path is a directory, async off of the main cocos thread. More...

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

virtual void	createDirectory (const std::string &dirPath, std::function< void(bool)> callback)
	Create a directory, async off the main cocos thread. More...

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

virtual void	removeDirectory (const std::string &dirPath, std::function< void(bool)> callback)
	Removes a directory, async off the main cocos thread. More...

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

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

virtual void	removeFile (const std::string &filepath, std::function< void(bool)> callback)
	Removes a file, async off the main cocos thread. More...

local	removeFile ( local filepath, local callback)
	Removes a file, async off the main cocos thread. More...

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

var	renameFile ( var path, var oldname, var 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 void	renameFile (const std::string &path, const std::string &oldname, const std::string &name, std::function< void(bool)> callback)
	Renames a file under the given directory, async off the main cocos thread. More...

var	renameFile ( var path, var oldname, var name, var callback)
	Renames a file under the given directory, async off the main cocos thread. More...

local	renameFile ( local path, local oldname, local name, local callback)
	Renames a file under the given directory, async off the main cocos thread. More...

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

virtual void	renameFile (const std::string &oldfullpath, const std::string &newfullpath, std::function< void(bool)> callback)
	Renames a file under the given directory, async off the main cocos thread. More...

local	renameFile ( local oldfullpath, local newfullpath, local callback)
	Renames a file under the given directory, async off the main cocos thread. More...

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

virtual void	getFileSize (const std::string &filepath, std::function< void(long)> callback)
	Retrieve the file size, async off the main cocos thread. More...

var	getFileSize ( var filepath, var callback)
	Retrieve the file size, async off the main cocos thread. More...

local	getFileSize ( local filepath, local callback)
	Retrieve the file size, async off the main cocos thread. More...

virtual std::vector< std::string >	listFiles (const std::string &dirPath) const
	List all files in a directory. More...

var	listFiles ( var dirPath)
	List all files in a directory. More...

local	listFiles ( local dirPath)
	List all files in a directory. More...

virtual void	listFilesAsync (const std::string &dirPath, std::function< void(std::vector< std::string >)> callback) const
	List all files in a directory async, off of the main cocos thread. More...

virtual void	listFilesRecursively (const std::string &dirPath, std::vector< std::string > *files) const
	List all files recursively in a directory. More...

local	listFilesRecursively ( local dirPath, local files)
	List all files recursively in a directory. More...

virtual void	listFilesRecursivelyAsync (const std::string &dirPath, std::function< void(std::vector< std::string >)> callback) const
	List all files recursively in a directory, async off the main cocos thread. More...

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

local	getFullPathCache ()
	Returns the full path cache. 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...

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

var	getInstance ()
	Gets the instance of FileUtils.

local	getInstance ()
	Gets the instance of FileUtils.

static void	destroyInstance ()
	Destroys the instance of FileUtils.

local	destroyInstance ()
	Destroys the instance of FileUtils.

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

Detailed Description

Helper class to handle file operations.

Member Function Documentation

virtual bool init ( )

overridevirtual

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 succeed, otherwise it returns false.

Reimplemented from FileUtils.

var init ( )

overridevirtual

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 succeed, otherwise it returns false.

Reimplemented from FileUtils.

local init ( )

overridevirtual

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 succeed, otherwise it returns false.

Reimplemented from FileUtils.

virtual std::string getWritablePath ( ) const

overridevirtual

Gets the writable path.

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

Implements FileUtils.

var getWritablePath ( )

overridevirtual

Gets the writable path.

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

Implements FileUtils.

local getWritablePath ( )

overridevirtual

Gets the writable path.

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

Implements FileUtils.

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

CCFileUtils-tizen.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation