Helper class to handle file operations. More...

#include <CCFileUtilsIOS.h>

Inheritance diagram for CCFileUtilsIOS:

Public Member Functions
virtual std::string	getWritablePath ()
	Gets the writable path. More...

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

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

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

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

virtual CCDictionary *	createCCDictionaryWithContentsOfFile (const std::string &filename)
	Creates a dictionary by the contents of a file. More...

virtual bool	writeToFile (CCDictionary *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 CCArray *	createCCArrayWithContentsOfFile (const std::string &filename)
	Creates an array by the contents of a file. More...

Public Member Functions inherited from CCFileUtils
virtual long	getClassTypeInfo ()
	Returns an unique ID for this class. More...

virtual	~CCFileUtils ()
	The destructor of CCFileUtils. More...

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

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

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

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

virtual unsigned char *	getFileDataFromZip (const char pszZipFilePath, const char pszFileName, unsigned long *pSize)
	Gets resource file data from a zip file. More...

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

virtual void	loadFilenameLookupDictionaryFromFile (const char *filename)
	Loads the filenameLookup dictionary from the contents of a filename. More...

virtual void	setFilenameLookupDictionary (CCDictionary *pFilenameLookupDict)
	Sets the filenameLookup dictionary. More...

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

virtual const char *	fullPathFromRelativeFile (const char pszFilename, const char pszRelativeFile)
	Gets full path from a file name and the path of the reletive file. More...

local	fullPathFromRelativeFile ( local pszFilename, local pszRelativeFile)
	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 char *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...

virtual void	addSearchPath (const char *path)
	Adds a path to search paths. More...

var	addSearchPath ( var path)
	Adds a path to search paths. More...

local	addSearchPath ( local path)
	Adds a path to search paths. More...

virtual void	removeSearchPath (const char *path)
	Removes a path from search paths. More...

void	removeAllPaths ()
	Removes all paths. More...

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

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

virtual bool	isPopupNotify ()

Additional Inherited Members
Static Public Member Functions inherited from CCFileUtils
static CCFileUtils *	sharedFileUtils ()
	Gets the instance of CCFileUtils. More...

local	sharedFileUtils ()
	Gets the instance of CCFileUtils. More...

static void	purgeFileUtils ()
	Destroys the instance of CCFileUtils. More...

var	purgeFileUtils ()
	Destroys the instance of CCFileUtils. More...

local	purgeFileUtils ()
	Destroys the instance of CCFileUtils. More...

Protected Member Functions inherited from CCFileUtils
	CCFileUtils ()
	The default constructor. More...

	CCFileUtils ()
	The default constructor. More...

	CCFileUtils ()
	The default constructor. More...

virtual bool	init ()
	Initializes the instance of CCFileUtils. More...

var	init ()
	Initializes the instance of CCFileUtils. More...

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

virtual std::string	getNewFilename (const char *pszFileName)
	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...

Protected Attributes inherited from CCFileUtils
CCDictionary *	m_pFilenameLookupDict
	Dictionary used to lookup filenames based on a key. More...

std::vector< std::string >	m_searchResolutionsOrderArray
	The vector contains resolution folders. More...

std::vector< std::string >	m_searchPathArray
	The vector contains search paths. More...

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

local	m_searchPathArray
	The vector contains search paths. More...

std::string	m_strDefaultResRootPath
	The default root path of resources. More...

var	m_strDefaultResRootPath
	The default root path of resources. More...

local	m_strDefaultResRootPath
	The default root path of resources. More...

std::map< std::string, std::string >	m_fullPathCache
	The full path cache. More...

Static Protected Attributes inherited from CCFileUtils
static CCFileUtils *	s_sharedFileUtils
	The singleton pointer of CCFileUtils. More...

var	s_sharedFileUtils
	The singleton pointer of CCFileUtils. More...

local	s_sharedFileUtils
	The singleton pointer of CCFileUtils. More...

Detailed Description

Helper class to handle file operations.

Member Function Documentation

virtual CCArray*
createCCArrayWithContentsOfFile ( const std::string & filename )

virtual

Creates an array by the contents of a file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

var createCCArrayWithContentsOfFile ( var filename )

virtual

Creates an array by the contents of a file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

local
createCCArrayWithContentsOfFile ( local filename )

virtual

Creates an array by the contents of a file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

virtual CCDictionary*
createCCDictionaryWithContentsOfFile ( const std::string & filename )

virtual

Creates a dictionary by the contents of a file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

var
createCCDictionaryWithContentsOfFile ( var filename )

virtual

Creates a dictionary by the contents of a file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

local
createCCDictionaryWithContentsOfFile ( local filename )

virtual

Creates a dictionary by the contents of a file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

virtual std::string getFullPathForDirectoryAndFilename	(	const std::string &	strDirectory,
		const std::string &	strFilename
	)

virtual

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

strDirectory	The directory contains the file we are looking for.
strFilename	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 from CCFileUtils.

var getFullPathForDirectoryAndFilename	(	var	strDirectory,
		var	strFilename
	)

virtual

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

strDirectory	The directory contains the file we are looking for.
strFilename	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 from CCFileUtils.

local getFullPathForDirectoryAndFilename	(	local	strDirectory,
		local	strFilename
	)

virtual

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

strDirectory	The directory contains the file we are looking for.
strFilename	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 from CCFileUtils.

virtual std::string getWritablePath ( )

virtual

Gets the writable path.

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

Implements CCFileUtils.

var getWritablePath ( )

virtual

Gets the writable path.

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

Implements CCFileUtils.

local getWritablePath ( )

virtual

Gets the writable path.

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

Implements CCFileUtils.

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

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

var isAbsolutePath ( var strPath )

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

local isAbsolutePath ( local strPath )

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

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

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

var isFileExist ( var strFilePath )

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

local isFileExist ( local strFilePath )

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

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

virtual

Write a dictionary to a plist file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

var writeToFile	(	var	dict,
		var	fullPath
	)

virtual

Write a dictionary to a plist file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

local writeToFile	(	local	dict,
		local	fullPath
	)

virtual

Write a dictionary to a plist file.

Note: This method is used internally.

Reimplemented from CCFileUtils.

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

/Users/guanghui/cocos2d-x/cocos2dx/platform/ios/CCFileUtilsIOS.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation