cocos2d-x  3.1rc0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
FileUtilsAndroid Class Reference

Helper class to handle file operations. More...

#include <CCFileUtilsAndroid.h>

Inheritance diagram for FileUtilsAndroid:
FileUtils

Public Member Functions

virtual ~FileUtilsAndroid ()
bool init ()
 Initializes the instance of FileUtils. More...
 
virtual
CC_DEPRECATED_ATTRIBUTE
unsigned char * 
getFileData (const std::string &filename, const char *mode, ssize_t *size) override
local getFileData ( local filename, local mode, local size)
virtual std::string getStringFromFile (const std::string &filename) override
 Gets string from a file. More...
 
virtual Data getDataFromFile (const std::string &filename) override
 Creates binary data from a file. More...
 
virtual std::string getWritablePath () const
 Gets the writable path. More...
 
virtual bool isAbsolutePath (const std::string &strPath) const
 Checks whether the path is an absolute path. More...
 
var isAbsolutePath ( var strPath)
 Checks whether the path is an absolute path. More...
 
local isAbsolutePath ( local strPath)
 Checks whether the path is an absolute path. More...
 
- Public Member Functions inherited from FileUtils
virtual ~FileUtils ()
 The destructor of FileUtils. More...
 
virtual void purgeCachedEntries ()
 Purges the file searching cache. More...
 
local purgeCachedEntries ()
 Purges the file searching cache. 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...
 
var getFileDataFromZip ( var zipFilePath, var filename, var size)
 Gets resource file data from a zip file. More...
 
local getFileDataFromZip ( local zipFilePath, local filename, local size)
 Gets resource file data from a zip file. More...
 
virtual std::string fullPathForFilename (const std::string &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...
 
virtual void setFilenameLookupDictionary (const ValueMap &filenameLookupDict)
 Sets the filenameLookup dictionary. More...
 
var setFilenameLookupDictionary ( var filenameLookupDict)
 Sets the filenameLookup dictionary. More...
 
local setFilenameLookupDictionary ( local 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 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 std::string &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...
 
void addSearchPath (const std::string &path)
 Add search path. More...
 
var addSearchPath ( var path)
 Add search path. More...
 
local addSearchPath ( local path)
 Add search path. More...
 
virtual const std::vector
< std::string > & 
getSearchPaths () const
 Gets the array of search paths. More...
 
var getSearchPaths ()
 Gets the array of search paths. More...
 
virtual bool isFileExist (const std::string &filename) const
 Checks whether a file exists. More...
 
local isFileExist ( local filename)
 Checks whether a file exists. More...
 
virtual void setPopupNotify (bool notify)
 Sets/Gets whether to pop-up a message box when failed to load an image. More...
 
virtual bool isPopupNotify ()
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 bool writeToFile (ValueMap &dict, const std::string &fullPath)
 Write a ValueMap to a plist file. More...
 
local writeToFile ( local dict, local fullPath)
 Write a ValueMap to a plist file. More...
 
virtual ValueVector getValueVectorFromFile (const std::string &filename)
 Converts the contents of a file to a ValueVector. More...
 
var getValueVectorFromFile ( var filename)
 Converts the contents of a file to a ValueVector. More...
 
local getValueVectorFromFile ( local filename)
 Converts the contents of a file to a ValueVector. More...
 
const std::unordered_map
< std::string, std::string > & 
getFullPathCache () const
 Returns the full path cache. More...
 

Static Public Member Functions

static void setassetmanager (AAssetManager *a)
var setassetmanager ( var a)
local setassetmanager ( local a)
- Static Public Member Functions inherited from FileUtils
static FileUtilsgetInstance ()
 Gets the instance of FileUtils. More...
 
local getInstance ()
 Gets the instance of FileUtils. More...
 
static void destroyInstance ()
 Destroys the instance of FileUtils. More...
 
var destroyInstance ()
 Destroys the instance of FileUtils. More...
 
local destroyInstance ()
 Destroys the instance of FileUtils. More...
 
static CC_DEPRECATED_ATTRIBUTE
FileUtils
sharedFileUtils ()
static CC_DEPRECATED_ATTRIBUTE void purgeFileUtils ()
local purgeFileUtils ()

Friends

class FileUtils

Additional Inherited Members

- Protected Member Functions inherited from FileUtils
 FileUtils ()
 The default constructor. 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...
 
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 &directory, const std::string &filename)
 Gets full path for the directory and the filename. More...
 
- Protected Attributes inherited from FileUtils
ValueMap _filenameLookupDict
 Dictionary used to lookup filenames based on a key. More...
 
std::vector< std::string > _searchResolutionsOrderArray
 The vector contains resolution folders. More...
 
std::vector< std::string > _searchPathArray
 The vector contains search paths. More...
 
var _searchPathArray
 The vector contains search paths. More...
 
local _searchPathArray
 The vector contains search paths. More...
 
std::string _defaultResRootPath
 The default root path of resources. More...
 
std::unordered_map
< std::string, std::string > 
_fullPathCache
 The full path cache. More...
 
- Static Protected Attributes inherited from FileUtils
static FileUtilss_sharedFileUtils
 The singleton pointer of FileUtils. More...
 
var s_sharedFileUtils
 The singleton pointer of FileUtils. More...
 
local s_sharedFileUtils
 The singleton pointer of FileUtils. More...
 

Detailed Description

Helper class to handle file operations.

Constructor & Destructor Documentation

virtual ~FileUtilsAndroid ( )
virtual

Member Function Documentation

virtual Data getDataFromFile ( const std::string &  filename)
overridevirtual

Creates binary data from a file.

Returns
A data object.

Reimplemented from FileUtils.

var getDataFromFile ( var  filename)
overridevirtual

Creates binary data from a file.

Returns
A data object.

Reimplemented from FileUtils.

local getDataFromFile ( local  filename)
overridevirtual

Creates binary data from a file.

Returns
A data object.

Reimplemented from FileUtils.

virtual
CC_DEPRECATED_ATTRIBUTE
unsigned char* getFileData
( const std::string &  filename,
const char *  mode,
ssize_t size 
)
overridevirtual
var getFileData ( var  filename,
var  mode,
var  size 
)
overridevirtual
local getFileData ( local  filename,
local  mode,
local  size 
)
overridevirtual
virtual std::string
getStringFromFile
( const std::string &  filename)
overridevirtual

Gets string from a file.

Reimplemented from FileUtils.

var getStringFromFile ( var  filename)
overridevirtual

Gets string from a file.

Reimplemented from FileUtils.

local getStringFromFile ( local  filename)
overridevirtual

Gets string from a file.

Reimplemented from FileUtils.

virtual std::string getWritablePath ( ) const
virtual

Gets the writable path.

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

Implements FileUtils.

var getWritablePath ( )
virtual

Gets the writable path.

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

Implements FileUtils.

local getWritablePath ( )
virtual

Gets the writable path.

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

Implements FileUtils.

bool init ( )
virtual

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

Reimplemented from FileUtils.

var init ( )
virtual

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

Reimplemented from FileUtils.

local init ( )
virtual

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

Reimplemented from FileUtils.

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

var isAbsolutePath ( var  path)
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 FileUtils.

local isAbsolutePath ( local  path)
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 FileUtils.

static void setassetmanager ( AAssetManager *  a)
static
var setassetmanager ( var  a)
static
local setassetmanager ( local  a)
static

Friends And Related Function Documentation

friend class FileUtils
friend
var FileUtils
friend
local FileUtils
friend

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