cocos2d-x  2.2.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CCFileUtilsAndroid Class Reference

Helper class to handle file operations. More...

#include <CCFileUtilsAndroid.h>

Inheritance diagram for CCFileUtilsAndroid:
CCFileUtils TypeInfo

Public Member Functions

virtual ~CCFileUtilsAndroid ()
bool init ()
 Initializes the instance of CCFileUtils. More...
 
virtual unsigned char * getFileData (const char *pszFileName, const char *pszMode, unsigned long *pSize)
 Gets resource file data. More...
 
var getFileData ( var pszFileName, var pszMode, var pSize)
 Gets resource file data. More...
 
local getFileData ( local pszFileName, local pszMode, local pSize)
 Gets resource file data. More...
 
virtual std::string 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...
 
virtual bool isAbsolutePath (const std::string &strPath)
 Checks whether the path is an absolute path. More...
 
unsigned char * getFileDataForAsync (const char *pszFileName, const char *pszMode, unsigned long *pSize)
 This function is android specific. 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 * 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 ()

Friends

class CCFileUtils

Additional Inherited Members

- Static Public Member Functions inherited from CCFileUtils
static CCFileUtilssharedFileUtils ()
 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 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...
 
local getFullPathForDirectoryAndFilename ( local strDirectory, local strFilename)
 Gets full path for the directory and the filename. More...
 
virtual CCDictionarycreateCCDictionaryWithContentsOfFile (const std::string &filename)
 Creates a dictionary by the contents of a file. More...
 
local createCCDictionaryWithContentsOfFile ( local 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 CCArraycreateCCArrayWithContentsOfFile (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
CCDictionarym_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 CCFileUtilss_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.

Constructor & Destructor Documentation

virtual ~CCFileUtilsAndroid ( )
virtual
var ~CCFileUtilsAndroid ( )
virtual
local ~CCFileUtilsAndroid ( )
virtual

Member Function Documentation

virtual unsigned char* getFileData ( const char *  pszFileName,
const char *  pszMode,
unsigned long *  pSize 
)
virtual

Gets resource file data.

Parameters
[in]pszFileNameThe resource file name which contains the path.
[in]pszModeThe read mode of the file.
[out]pSizeIf the file read operation succeeds, it will be the data size, otherwise 0.
Returns
Upon success, a pointer to the data is returned, otherwise NULL.
Warning
Recall: you are responsible for calling delete[] on any Non-NULL pointer returned.

Reimplemented from CCFileUtils.

var getFileData ( var  pszFileName,
var  pszMode,
var  pSize 
)
virtual

Gets resource file data.

Parameters
[in]pszFileNameThe resource file name which contains the path.
[in]pszModeThe read mode of the file.
[out]pSizeIf the file read operation succeeds, it will be the data size, otherwise 0.
Returns
Upon success, a pointer to the data is returned, otherwise NULL.
Warning
Recall: you are responsible for calling delete[] on any Non-NULL pointer returned.

Reimplemented from CCFileUtils.

local getFileData ( local  pszFileName,
local  pszMode,
local  pSize 
)
virtual

Gets resource file data.

Parameters
[in]pszFileNameThe resource file name which contains the path.
[in]pszModeThe read mode of the file.
[out]pSizeIf the file read operation succeeds, it will be the data size, otherwise 0.
Returns
Upon success, a pointer to the data is returned, otherwise NULL.
Warning
Recall: you are responsible for calling delete[] on any Non-NULL pointer returned.

Reimplemented from CCFileUtils.

unsigned char* getFileDataForAsync ( const char *  pszFileName,
const char *  pszMode,
unsigned long *  pSize 
)

This function is android specific.

It is used for CCTextureCache::addImageAsync(). Don't use it in your codes.

var getFileDataForAsync ( var  pszFileName,
var  pszMode,
var  pSize 
)

This function is android specific.

It is used for CCTextureCache::addImageAsync(). Don't use it in your codes.

local getFileDataForAsync ( local  pszFileName,
local  pszMode,
local  pSize 
)

This function is android specific.

It is used for CCTextureCache::addImageAsync(). Don't use it in your codes.

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

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

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

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
strPathThe 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
strPathThe 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
strPathThe 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
strFilePathThe 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
strFilePathThe 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
strFilePathThe 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: