Cocos2d-x  v3.11
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
FileUtilsTizen Class Reference

Helper class to handle file operations. More...

Inherits FileUtils.

Public Member Functions

virtual bool init () override
 Initializes the instance of FileUtils. More...
 
virtual std::string getWritablePath () const override
 Gets the writable path. More...
 
- Public Member Functions inherited from FileUtils
virtual ~FileUtils ()
 The destructor of FileUtils.
 
virtual void purgeCachedEntries ()
 Purges full path caches.
 
virtual std::string getStringFromFile (const std::string &filename)
 Gets string from a file.
 
virtual Data getDataFromFile (const std::string &filename)
 Creates binary data from a file. More...
 
virtual unsigned char * getFileData (const std::string &filename, const char *mode, ssize_t *size)
 Gets resource file data The resource file name which contains the path. 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...
 
virtual std::string fullPathForFilename (const std::string &filename) const
 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...
 
virtual std::string fullPathFromRelativeFile (const std::string &filename, const std::string &relativeFile)
 Gets full path from a file name and the path of the relative 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, const bool front=false)
 Append search order of the resources.
 
virtual const std::vector
< std::string > & 
getSearchResolutionsOrder () const
 Gets the array that contains the search order of the resources.
 
virtual void setSearchPaths (const std::vector< std::string > &searchPaths)
 Sets the array of search paths. More...
 
void setDefaultResourceRootPath (const std::string &path)
 Set default resource root path.
 
void addSearchPath (const std::string &path, const bool front=false)
 Add search path.
 
virtual const std::vector
< std::string > & 
getSearchPaths () const
 Gets the array of search paths. More...
 
virtual void setWritablePath (const std::string &writablePath)
 Sets writable path.
 
virtual void setPopupNotify (bool notify)
 Sets whether to pop-up a message box when failed to load an image.
 
virtual bool isPopupNotify () const
 Checks whether to pop up a message box when failed to load an image. More...
 
virtual ValueMap getValueMapFromFile (const std::string &filename)
 Converts the contents of a file to a ValueMap. More...
 
virtual ValueMap getValueMapFromData (const char *filedata, int filesize)
 Converts the contents of a file to a ValueMap. More...
 
virtual bool writeToFile (const ValueMap &dict, const std::string &fullPath)
 Write a ValueMap to a plist file. More...
 
virtual bool writeStringToFile (const std::string &dataStr, const std::string &fullPath)
 write a string into a file More...
 
virtual bool writeDataToFile (const Data &data, const std::string &fullPath)
 write Data into a file More...
 
virtual bool writeValueMapToFile (const ValueMap &dict, const std::string &fullPath)
 write ValueMap into a plist file More...
 
virtual bool writeValueVectorToFile (const ValueVector &vecData, const std::string &fullPath)
 write ValueVector into a plist file More...
 
virtual std::string getSuitableFOpen (const std::string &filenameUtf8) const
 Windows fopen can't support UTF-8 filename Need convert all parameters fopen and other 3rd-party libs. More...
 
virtual ValueVector getValueVectorFromFile (const std::string &filename)
 Converts the contents of a file to a ValueVector. More...
 
virtual bool isFileExist (const std::string &filename) const
 Checks whether a file exists. More...
 
virtual std::string getFileExtension (const std::string &filePath) const
 Gets filename extension is a suffix (separated from the base filename by a dot) in lower case. More...
 
virtual bool isAbsolutePath (const std::string &path) const
 Checks whether the path is an absolute path. More...
 
virtual bool isDirectoryExist (const std::string &dirPath) const
 Checks whether the path is a directory. More...
 
virtual bool createDirectory (const std::string &dirPath)
 Creates a directory. More...
 
virtual bool removeDirectory (const std::string &dirPath)
 Removes a directory. More...
 
virtual bool removeFile (const std::string &filepath)
 Removes a file. More...
 
virtual bool renameFile (const std::string &path, const std::string &oldname, const std::string &name)
 Renames a file under the given directory. More...
 
virtual bool renameFile (const std::string &oldfullpath, const std::string &newfullpath)
 Renames a file under the given directory. More...
 
virtual long getFileSize (const std::string &filepath)
 Retrieve the file size. More...
 
const std::unordered_map
< std::string, std::string > & 
getFullPathCache () const
 Returns the full path cache.
 

Additional Inherited Members

- Static Public Member Functions inherited from FileUtils
static FileUtilsgetInstance ()
 Gets the instance of FileUtils.
 
static void destroyInstance ()
 Destroys the instance of FileUtils.
 
static void setDelegate (FileUtils *delegate)
 You can inherit from platform dependent implementation of FileUtils, such as FileUtilsAndroid, and use this function to set delegate, then FileUtils will invoke delegate's implementation. More...
 
static FileUtilssharedFileUtils ()
static void purgeFileUtils ()

Detailed Description

Helper class to handle file operations.

Member Function Documentation

virtual bool init ( )
overridevirtual

Initializes the instance of FileUtils.

It will set _searchPathArray and _searchResolutionsOrderArray to default values.

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(). true if successed, otherwise it returns false.

Reimplemented from FileUtils.

virtual std::string getWritablePath ( ) const
overridevirtual

Gets the writable path.

The path that can be write/read a file in

Implements FileUtils.


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