Helper class to handle file operations. More...

#include <CCFileUtilsWin32.h>

Inheritance diagram for CCFileUtilsWin32:

Collaboration diagram for CCFileUtilsWin32:

Public Member Functions
bool	init ()
	Initializes the instance of CCFileUtils. More...

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

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

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

virtual std::string	getWritablePath2 ()

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

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

virtual bool	init ()
	Initializes the instance of CCFileUtils. 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	fullPathForFilename (const char *pszFileName)

std::string	utf8Togbk (const char *src)

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

virtual unsigned char *	getFileData (const char pszFileName, const char pszMode, unsigned long *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 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...

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

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

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 std::string	getWritablePath ()=0
	Gets the writable path. More...

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

virtual bool	isAbsolutePath (const std::string &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 ()

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

virtual void	removeFullPath (const char *path)

virtual long	getClassTypeInfo ()=0

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

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

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

virtual CCArray *	createCCArrayWithContentsOfFile (const std::string &filename)
	Creates an array by the contents of a file. More...

virtual bool	shouldUseHD ()

virtual std::string	addSuffix (std::string, std::string)

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

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

Detailed Description

Helper class to handle file operations.

Member Function Documentation

◆ addSearchPath()

virtual void addSearchPath ( const char * path )

virtual

Adds a path to search paths.

Since: v2.2

Reimplemented from CCFileUtils.

◆ fullPathForFilename()

virtual std::string fullPathForFilename ( const char * pszFileName )

virtual

◆ getPathForFilename()

virtual std::string getPathForFilename	(	const std::string &	filename,
		const std::string &	resolutionDirectory,
		const std::string &	searchPath
	)

virtual

Gets full path for filename, resolution directory and search path.

Parameters

filename	The file name.
resolutionDirectory	The resolution directory.
searchPath	The search path.

Returns: The full path of the file. It will return an empty string if the full path of the file doesn't exist.

Reimplemented from CCFileUtils.

◆ getWritablePath()

virtual std::string getWritablePath ( )

virtual

Gets the writable path.

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

Implements CCFileUtils.

◆ getWritablePath2()

virtual std::string getWritablePath2 ( )

virtual

Remarks: Added by RobTop. See RT_ADD for more info.

Reimplemented from CCFileUtils.

◆ init() [1/2]

bool init ( )

virtual

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.

◆ init() [2/2]

virtual bool init ( )

virtual

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.

◆ isAbsolutePath()

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

Reimplemented from CCFileUtils.

◆ isFileExist()

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

Implements CCFileUtils.

◆ removeSearchPath()

virtual void removeSearchPath ( const char * path )

virtual

Removes a path from search paths.

Since: v2.2 NA

Reimplemented from CCFileUtils.

◆ utf8Togbk()

std::string utf8Togbk ( const char * src )

Friends And Related Function Documentation

◆ CCFileUtils

friend class CCFileUtils

friend

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

/home/runner/work/cocos-headers/cocos-headers/cocos2dx/platform/win32/CCFileUtilsWin32.h

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addSearchPath()

◆ fullPathForFilename()

◆ getPathForFilename()

◆ getWritablePath()

◆ getWritablePath2()

◆ init() [1/2]

◆ init() [2/2]

◆ isAbsolutePath()

◆ isFileExist()

◆ removeSearchPath()

◆ utf8Togbk()

Friends And Related Function Documentation

◆ CCFileUtils