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

Helper class to handle file operations. More...

#include <CCFileUtilsNaCl.h>

Inheritance diagram for FileUtilsNaCl:
FileUtils

Public Member Functions

bool init ()
 Initializes the instance of FileUtils. More...
 
virtual std::string getWritablePath ()
virtual bool isFileExist (const std::string &strFilePath)
local isFileExist ( local strFilePath)
- 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, unsigned 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, unsigned 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 std::string getWritablePath () const =0
 Gets the writable path. More...
 
virtual bool isFileExist (const std::string &filePath) const =0
 Checks whether a file exists. More...
 
local isFileExist ( local filePath)
 Checks whether a file exists. 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 ()

Friends

class FileUtils

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 FileUtilssharedFileUtils ()
local sharedFileUtils ()
static void purgeFileUtils ()
var purgeFileUtils ()
local purgeFileUtils ()
- Protected Member Functions inherited from FileUtils
 FileUtils ()
 The default constructor. More...
 
 FileUtils ()
 The default constructor. 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...
 
virtual std::string getFullPathForDirectoryAndFilename (const std::string &directory, const std::string &filename)
 Gets full path for the directory and the filename. More...
 
local getFullPathForDirectoryAndFilename ( local directory, local filename)
 Gets full path for the directory and the filename. More...
 
virtual DictionarycreateDictionaryWithContentsOfFile (const std::string &filename)
 Creates a dictionary by the contents of a file. More...
 
virtual bool writeToFile (Dictionary *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 ArraycreateArrayWithContentsOfFile (const std::string &filename)
 Creates an array by the contents of a file. 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...
 
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::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 std::string getWritablePath ( )
virtual
var getWritablePath ( )
virtual
local getWritablePath ( )
virtual
bool init ( )
inlinevirtual

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

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

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 isFileExist ( const std::string &  strFilePath)
virtual
var isFileExist ( var  strFilePath)
virtual
local isFileExist ( local  strFilePath)
virtual

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: