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

Helper class to handle file operations. More...

#include <CCFileUtils-linux.h>

Inheritance diagram for FileUtilsLinux:
FileUtils

Public Member Functions

bool init ()
 Initializes the instance of FileUtils. More...
 
virtual std::string getWritablePath () const
 Gets the writable 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 std::string getStringFromFile (const std::string &filename)
 Gets string from a file. More...
 
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. More...
 
var getFileData ( var filename, var mode, var size)
 Gets resource file data. More...
 
local getFileData ( local filename, local mode, local size)
 Gets resource file data. 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, const bool front=false)
 Append search order of the resources. More...
 
var addSearchResolutionsOrder ( var order, var false)
 Append search order of the resources. More...
 
local addSearchResolutionsOrder ( local order, local false)
 Append search order of the resources. More...
 
virtual const std::vector
< std::string > & 
getSearchResolutionsOrder () const
 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, const bool front=false)
 Add search path. More...
 
virtual const std::vector
< std::string > & 
getSearchPaths () const
 Gets the array of search paths. More...
 
virtual void setPopupNotify (bool notify)
 Sets/Gets whether to pop-up a message box when failed to load an image. More...
 
var setPopupNotify ( var notify)
 Sets/Gets whether to pop-up a message box when failed to load an image. More...
 
local setPopupNotify ( local 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 ValueMap getValueMapFromData (const char *filedata, int filesize)
 Converts the contents of a file to a ValueMap. More...
 
var getValueMapFromData ( var filedata, var filesize)
 Converts the contents of a file to a ValueMap. More...
 
local getValueMapFromData ( local filedata, local filesize)
 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...
 
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 bool isAbsolutePath (const std::string &path) const
 Checks whether the path is an absolute path. More...
 
virtual bool isDirectoryExist (const std::string &dirPath)
 Checks whether the path is a directory. More...
 
local isDirectoryExist ( local dirPath)
 Checks whether the path is a directory. More...
 
virtual bool createDirectory (const std::string &dirPath)
 Creates a directory. More...
 
var createDirectory ( var dirPath)
 Creates a directory. More...
 
local createDirectory ( local dirPath)
 Creates a directory. More...
 
virtual bool removeDirectory (const std::string &dirPath)
 Remove a directory. More...
 
var removeDirectory ( var dirPath)
 Remove a directory. More...
 
local removeDirectory ( local dirPath)
 Remove a directory. More...
 
virtual bool removeFile (const std::string &filepath)
 Remove a file. More...
 
var removeFile ( var filepath)
 Remove a file. More...
 
local removeFile ( local filepath)
 Remove a file. More...
 
virtual bool renameFile (const std::string &path, const std::string &oldname, const std::string &name)
 Rename a file under the given directory. More...
 
var renameFile ( var path, var oldname, var name)
 Rename a file under the given directory. More...
 
local renameFile ( local path, local oldname, local name)
 Rename 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. More...
 
var getFullPathCache ()
 Returns the full path cache. More...
 
local getFullPathCache ()
 Returns the full path cache. More...
 

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...
 
static FileUtilssharedFileUtils ()
var sharedFileUtils ()
local sharedFileUtils ()
static void purgeFileUtils ()
local purgeFileUtils ()
- 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 bool isDirectoryExistInternal (const std::string &dirPath) const
 Checks whether a directory exists without considering search paths and resolution orders. 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...
 
local getFullPathForDirectoryAndFilename ( local directory, local filename)
 Gets full path for the directory and the filename. More...
 
virtual std::string searchFullPathForFilename (const std::string &filename) const
 Returns the fullpath for a given 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.

Member Function Documentation

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.

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: