cocos2d-x  3.0alpha1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
FileUtilsApple Class Reference

Helper class to handle file operations. More...

#include <CCFileUtilsApple.h>

Inheritance diagram for FileUtilsApple:
FileUtils

Public Member Functions

virtual std::string getWritablePath () const override
 Gets the writable path. More...
 
local getWritablePath ()
 Gets the writable path. More...
 
virtual bool isFileExist (const std::string &strFilePath) const override
 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 std::string getFullPathForDirectoryAndFilename (const std::string &strDirectory, const std::string &strFilename) override
 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 DictionarycreateDictionaryWithContentsOfFile (const std::string &filename) override
 Creates a dictionary by the contents of a file. More...
 
virtual bool writeToFile (Dictionary *dict, const std::string &fullPath) override
 Write a dictionary to a plist file. More...
 
virtual ArraycreateArrayWithContentsOfFile (const std::string &filename) override
 Creates an array by the contents of a file. More...
 
local createArrayWithContentsOfFile ( local filename)
 Creates an array by the contents of a file. More...
 
- Public Member Functions inherited from FileUtils
virtual ~FileUtils ()
 The destructor of FileUtils. More...
 
virtual void purgeCachedEntries ()
 Purges the file searching cache. More...
 
var purgeCachedEntries ()
 Purges the file searching cache. More...
 
local purgeCachedEntries ()
 Purges the file searching cache. More...
 
virtual unsigned char * getFileData (const char *filename, const char *mode, long *size)
 Gets resource file data. More...
 
local getFileData ( local filename, local mode, local size)
 Gets resource file data. More...
 
virtual unsigned char * getFileDataFromZip (const char *zipFilePath, const char *filename, long *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...
 
virtual void loadFilenameLookupDictionaryFromFile (const std::string &filename)
 Loads the filenameLookup dictionary from the contents of a filename. More...
 
var loadFilenameLookup ( var filename)
 Loads the filenameLookup dictionary from the contents of a filename. More...
 
local loadFilenameLookup ( local filename)
 Loads the filenameLookup dictionary from the contents of a filename. More...
 
virtual void setFilenameLookupDictionary (Dictionary *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...
 
var fullPathFromRelativeFile ( var filename, var relativeFile)
 Gets full path from a file name and the path of the reletive file. More...
 
local fullPathFromRelativeFile ( local filename, local 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...
 
var setSearchPaths ( var 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...
 
virtual bool isAbsolutePath (const std::string &path) const
 Checks whether the path is an absolute path. More...
 
local isAbsolutePath ( local path)
 Checks whether the path is an absolute path. 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 ()

Additional Inherited Members

- 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 ()
local sharedFileUtils ()
static CC_DEPRECATED_ATTRIBUTE void purgeFileUtils ()
local purgeFileUtils ()
- Protected Member Functions inherited from FileUtils
 FileUtils ()
 The default constructor. More...
 
 FileUtils ()
 The default constructor. More...
 
virtual bool init ()
 Initializes the instance of FileUtils. More...
 
virtual std::string getNewFilename (const std::string &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...
 
- Protected Attributes inherited from FileUtils
Dictionary_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...
 
std::string _defaultResRootPath
 The default root path of resources. More...
 
std::map< std::string,
std::string > 
_fullPathCache
 The full path cache. More...
 
local _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.

Member Function Documentation

virtual Array*
createArrayWithContentsOfFile
( const std::string &  filename)
overridevirtual

Creates an array by the contents of a file.

Note
This method is used internally.

Reimplemented from FileUtils.

var createArrayWithContentsOfFile ( var  filename)
overridevirtual

Creates an array by the contents of a file.

Note
This method is used internally.

Reimplemented from FileUtils.

local createArrayWithContentsOfFile ( local  filename)
overridevirtual

Creates an array by the contents of a file.

Note
This method is used internally.

Reimplemented from FileUtils.

virtual Dictionary*
createDictionaryWithContentsOfFile
( const std::string &  filename)
overridevirtual

Creates a dictionary by the contents of a file.

Note
This method is used internally.

Reimplemented from FileUtils.

var
createDictionaryWithContentsOfFile
( var  filename)
overridevirtual

Creates a dictionary by the contents of a file.

Note
This method is used internally.

Reimplemented from FileUtils.

local
createDictionaryWithContentsOfFile
( local  filename)
overridevirtual

Creates a dictionary by the contents of a file.

Note
This method is used internally.

Reimplemented from FileUtils.

virtual std::string
getFullPathForDirectoryAndFilename
( const std::string &  directory,
const std::string &  filename 
)
overridevirtual

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
strDirectoryThe directory contains the file we are looking for.
strFilenameThe 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 FileUtils.

var
getFullPathForDirectoryAndFilename
( var  directory,
var  filename 
)
overridevirtual

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
strDirectoryThe directory contains the file we are looking for.
strFilenameThe 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 FileUtils.

local
getFullPathForDirectoryAndFilename
( local  directory,
local  filename 
)
overridevirtual

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
strDirectoryThe directory contains the file we are looking for.
strFilenameThe 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 FileUtils.

virtual std::string getWritablePath ( ) const
overridevirtual

Gets the writable path.

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

Implements FileUtils.

var getWritablePath ( )
overridevirtual

Gets the writable path.

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

Implements FileUtils.

local getWritablePath ( )
overridevirtual

Gets the writable path.

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

Implements FileUtils.

virtual bool isFileExist ( const std::string &  filePath) const
overridevirtual

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

var isFileExist ( var  filePath)
overridevirtual

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

local isFileExist ( local  filePath)
overridevirtual

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

virtual bool writeToFile ( Dictionary dict,
const std::string &  fullPath 
)
overridevirtual

Write a dictionary to a plist file.

Note
This method is used internally.

Reimplemented from FileUtils.

var writeToFile ( var  dict,
var  fullPath 
)
overridevirtual

Write a dictionary to a plist file.

Note
This method is used internally.

Reimplemented from FileUtils.

local writeToFile ( local  dict,
local  fullPath 
)
overridevirtual

Write a dictionary to a plist file.

Note
This method is used internally.

Reimplemented from FileUtils.


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