CCFileUtilsNaCl Class Reference

Helper class to handle file operations. More...

#include <CCFileUtilsNaCl.h>

Inheritance diagram for CCFileUtilsNaCl:

Public Member Functions
bool	init ()
	Initializes the instance of CCFileUtils. More...
virtual std::string	getWritablePath ()
	Gets the writable path. More...
var	getWritablePath ()
	Gets the writable path. More...
local	getWritablePath ()
	Gets the writable path. More...
virtual bool	isFileExist (const std::string &strFilePath)
	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...
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...
local	getFileDataFromZip ( local pszZipFilePath, local pszFileName, local 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...
local	fullPathForFilename ( local 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...
var	loadFilenameLookupDictionaryFromFile ( var filename)
	Loads the filenameLookup dictionary from the contents of a filename. More...
local	loadFilenameLookupDictionaryFromFile ( local filename)
	Loads the filenameLookup dictionary from the contents of a filename. More...
virtual void	setFilenameLookupDictionary (CCDictionary *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...
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 bool	isAbsolutePath (const std::string &strPath)
	Checks whether the path is an absolute path. More...
var	isAbsolutePath ( var strPath)
	Checks whether the path is an absolute path. 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 ()

Friends
class	CCFileUtils

Additional Inherited Members
Static Public Member Functions inherited from CCFileUtils
static CCFileUtils *	sharedFileUtils ()
	Gets the instance of CCFileUtils. More...
static void	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 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...
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 &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...
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...
var	createCCArrayWithContentsOfFile ( var filename)
	Creates an array by the contents of a file. More...
local	createCCArrayWithContentsOfFile ( local filename)
	Creates an array by the contents of a file. 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...
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 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.

bool init ( )

inlinevirtual

Initializes the instance of CCFileUtils.

It will set m_searchPathArray and m_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 m_strDefaultResRootPath in the subclass of CCFileUtils(e.g. CCFileUtilsAndroid). Then invoke the CCFileUtils::init().

Returns

true if successed, otherwise it returns false.

Reimplemented from CCFileUtils.

var init ( )

inlinevirtual

Initializes the instance of CCFileUtils.

It will set m_searchPathArray and m_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 m_strDefaultResRootPath in the subclass of CCFileUtils(e.g. CCFileUtilsAndroid). Then invoke the CCFileUtils::init().

Returns

true if successed, otherwise it returns false.

Reimplemented from CCFileUtils.

local init ( )

inlinevirtual

Initializes the instance of CCFileUtils.

It will set m_searchPathArray and m_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 m_strDefaultResRootPath in the subclass of CCFileUtils(e.g. CCFileUtilsAndroid). Then invoke the CCFileUtils::init().

Returns

true if successed, otherwise it returns 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.

Friends And Related Function Documentation

friend class CCFileUtils

friend

var CCFileUtils

friend

local CCFileUtils

friend

---

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

• /Users/cocos2d/MyWork/cocos2d-x/cocos2dx/platform/nacl/CCFileUtilsNaCl.h