mirror of https://github.com/axmolengine/axmol.git
511 lines
21 KiB
C++
511 lines
21 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2010-2013 cocos2d-x.org
|
|
Copyright (c) 2013-2014 Chukong Technologies Inc.
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
#ifndef __CC_FILEUTILS_H__
|
|
#define __CC_FILEUTILS_H__
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
#include <unordered_map>
|
|
|
|
#include "base/CCPlatformMacros.h"
|
|
#include "base/ccTypes.h"
|
|
#include "base/CCValue.h"
|
|
#include "base/CCData.h"
|
|
|
|
NS_CC_BEGIN
|
|
|
|
/**
|
|
* @addtogroup platform
|
|
* @{
|
|
*/
|
|
|
|
//! @brief Helper class to handle file operations
|
|
class CC_DLL FileUtils
|
|
{
|
|
public:
|
|
/**
|
|
* Gets the instance of FileUtils.
|
|
*/
|
|
static FileUtils* getInstance();
|
|
|
|
/**
|
|
* Destroys the instance of FileUtils.
|
|
*/
|
|
static void destroyInstance();
|
|
|
|
/** @deprecated Use getInstance() instead */
|
|
CC_DEPRECATED_ATTRIBUTE static FileUtils* sharedFileUtils() { return getInstance(); }
|
|
|
|
/** @deprecated Use destroyInstance() instead */
|
|
CC_DEPRECATED_ATTRIBUTE static void purgeFileUtils() { destroyInstance(); }
|
|
|
|
/**
|
|
* The destructor of FileUtils.
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~FileUtils();
|
|
|
|
/**
|
|
* Purges the file searching cache.
|
|
*
|
|
* @note It should be invoked after the resources were updated.
|
|
* For instance, in the CocosPlayer sample, every time you run application from CocosBuilder,
|
|
* All the resources will be downloaded to the writable folder, before new js app launchs,
|
|
* this method should be invoked to clean the file search cache.
|
|
*/
|
|
virtual void purgeCachedEntries();
|
|
|
|
/**
|
|
* Gets string from a file.
|
|
*/
|
|
virtual std::string getStringFromFile(const std::string& filename);
|
|
|
|
/**
|
|
* Creates binary data from a file.
|
|
* @return A data object.
|
|
*/
|
|
virtual Data getDataFromFile(const std::string& filename);
|
|
|
|
/**
|
|
* Gets resource file data
|
|
*
|
|
* @param[in] filename The resource file name which contains the path.
|
|
* @param[in] pszMode The read mode of the file.
|
|
* @param[out] pSize If the file read operation succeeds, it will be the data size, otherwise 0.
|
|
* @return Upon success, a pointer to the data is returned, otherwise NULL.
|
|
* @warning Recall: you are responsible for calling free() on any Non-NULL pointer returned.
|
|
*/
|
|
CC_DEPRECATED_ATTRIBUTE virtual unsigned char* getFileData(const std::string& filename, const char* mode, ssize_t *size);
|
|
|
|
/**
|
|
* Gets resource file data from a zip file.
|
|
*
|
|
* @param[in] filename The resource file name which contains the relative path of the zip file.
|
|
* @param[out] size If the file read operation succeeds, it will be the data size, otherwise 0.
|
|
* @return Upon success, a pointer to the data is returned, otherwise nullptr.
|
|
* @warning Recall: you are responsible for calling free() on any Non-nullptr pointer returned.
|
|
*/
|
|
virtual unsigned char* getFileDataFromZip(const std::string& zipFilePath, const std::string& filename, ssize_t *size);
|
|
|
|
|
|
/** Returns the fullpath for a given filename.
|
|
|
|
First it will try to get a new filename from the "filenameLookup" dictionary.
|
|
If a new filename can't be found on the dictionary, it will use the original filename.
|
|
Then it will try to obtain the full path of the filename using the FileUtils search rules: resolutions, and search paths.
|
|
The file search is based on the array element order of search paths and resolution directories.
|
|
|
|
For instance:
|
|
|
|
We set two elements("/mnt/sdcard/", "internal_dir/") to search paths vector by setSearchPaths,
|
|
and set three elements("resources-ipadhd/", "resources-ipad/", "resources-iphonehd")
|
|
to resolutions vector by setSearchResolutionsOrder. The "internal_dir" is relative to "Resources/".
|
|
|
|
If we have a file named 'sprite.png', the mapping in fileLookup dictionary contains `key: sprite.png -> value: sprite.pvr.gz`.
|
|
Firstly, it will replace 'sprite.png' with 'sprite.pvr.gz', then searching the file sprite.pvr.gz as follows:
|
|
|
|
/mnt/sdcard/resources-ipadhd/sprite.pvr.gz (if not found, search next)
|
|
/mnt/sdcard/resources-ipad/sprite.pvr.gz (if not found, search next)
|
|
/mnt/sdcard/resources-iphonehd/sprite.pvr.gz (if not found, search next)
|
|
/mnt/sdcard/sprite.pvr.gz (if not found, search next)
|
|
internal_dir/resources-ipadhd/sprite.pvr.gz (if not found, search next)
|
|
internal_dir/resources-ipad/sprite.pvr.gz (if not found, search next)
|
|
internal_dir/resources-iphonehd/sprite.pvr.gz (if not found, search next)
|
|
internal_dir/sprite.pvr.gz (if not found, return "sprite.png")
|
|
|
|
If the filename contains relative path like "gamescene/uilayer/sprite.png",
|
|
and the mapping in fileLookup dictionary contains `key: gamescene/uilayer/sprite.png -> value: gamescene/uilayer/sprite.pvr.gz`.
|
|
The file search order will be:
|
|
|
|
/mnt/sdcard/gamescene/uilayer/resources-ipadhd/sprite.pvr.gz (if not found, search next)
|
|
/mnt/sdcard/gamescene/uilayer/resources-ipad/sprite.pvr.gz (if not found, search next)
|
|
/mnt/sdcard/gamescene/uilayer/resources-iphonehd/sprite.pvr.gz (if not found, search next)
|
|
/mnt/sdcard/gamescene/uilayer/sprite.pvr.gz (if not found, search next)
|
|
internal_dir/gamescene/uilayer/resources-ipadhd/sprite.pvr.gz (if not found, search next)
|
|
internal_dir/gamescene/uilayer/resources-ipad/sprite.pvr.gz (if not found, search next)
|
|
internal_dir/gamescene/uilayer/resources-iphonehd/sprite.pvr.gz (if not found, search next)
|
|
internal_dir/gamescene/uilayer/sprite.pvr.gz (if not found, return "gamescene/uilayer/sprite.png")
|
|
|
|
If the new file can't be found on the file system, it will return the parameter filename directly.
|
|
|
|
This method was added to simplify multiplatform support. Whether you are using cocos2d-js or any cross-compilation toolchain like StellaSDK or Apportable,
|
|
you might need to load different resources for a given file in the different platforms.
|
|
|
|
@since v2.1
|
|
*/
|
|
virtual std::string fullPathForFilename(const std::string &filename);
|
|
|
|
/**
|
|
* Loads the filenameLookup dictionary from the contents of a filename.
|
|
*
|
|
* @note The plist file name should follow the format below:
|
|
*
|
|
* @code
|
|
* <?xml version="1.0" encoding="UTF-8"?>
|
|
* <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
* <plist version="1.0">
|
|
* <dict>
|
|
* <key>filenames</key>
|
|
* <dict>
|
|
* <key>sounds/click.wav</key>
|
|
* <string>sounds/click.caf</string>
|
|
* <key>sounds/endgame.wav</key>
|
|
* <string>sounds/endgame.caf</string>
|
|
* <key>sounds/gem-0.wav</key>
|
|
* <string>sounds/gem-0.caf</string>
|
|
* </dict>
|
|
* <key>metadata</key>
|
|
* <dict>
|
|
* <key>version</key>
|
|
* <integer>1</integer>
|
|
* </dict>
|
|
* </dict>
|
|
* </plist>
|
|
* @endcode
|
|
* @param filename The plist file name.
|
|
*
|
|
@since v2.1
|
|
* @js loadFilenameLookup
|
|
* @lua loadFilenameLookup
|
|
*/
|
|
virtual void loadFilenameLookupDictionaryFromFile(const std::string &filename);
|
|
|
|
/**
|
|
* Sets the filenameLookup dictionary.
|
|
*
|
|
* @param pFilenameLookupDict The dictionary for replacing filename.
|
|
* @since v2.1
|
|
*/
|
|
virtual void setFilenameLookupDictionary(const ValueMap& filenameLookupDict);
|
|
|
|
/**
|
|
* Gets full path from a file name and the path of the reletive file.
|
|
* @param filename The file name.
|
|
* @param pszRelativeFile The path of the relative file.
|
|
* @return The full path.
|
|
* e.g. filename: hello.png, pszRelativeFile: /User/path1/path2/hello.plist
|
|
* Return: /User/path1/path2/hello.pvr (If there a a key(hello.png)-value(hello.pvr) in FilenameLookup dictionary. )
|
|
*
|
|
*/
|
|
virtual std::string fullPathFromRelativeFile(const std::string &filename, const std::string &relativeFile);
|
|
|
|
/**
|
|
* Sets the array that contains the search order of the resources.
|
|
*
|
|
* @param searchResolutionsOrder The source array that contains the search order of the resources.
|
|
* @see getSearchResolutionsOrder(void), fullPathForFilename(const char*).
|
|
* @since v2.1
|
|
* In js:var setSearchResolutionsOrder(var jsval)
|
|
* @lua NA
|
|
*/
|
|
virtual void setSearchResolutionsOrder(const std::vector<std::string>& searchResolutionsOrder);
|
|
|
|
/**
|
|
* Append search order of the resources.
|
|
*
|
|
* @see setSearchResolutionsOrder(), fullPathForFilename().
|
|
* @since v2.1
|
|
*/
|
|
virtual void addSearchResolutionsOrder(const std::string &order,const bool front=false);
|
|
|
|
/**
|
|
* Gets the array that contains the search order of the resources.
|
|
*
|
|
* @see setSearchResolutionsOrder(const std::vector<std::string>&), fullPathForFilename(const char*).
|
|
* @since v2.1
|
|
* @lua NA
|
|
*/
|
|
virtual const std::vector<std::string>& getSearchResolutionsOrder();
|
|
|
|
/**
|
|
* Sets the array of search paths.
|
|
*
|
|
* You can use this array to modify the search path of the resources.
|
|
* If you want to use "themes" or search resources in the "cache", you can do it easily by adding new entries in this array.
|
|
*
|
|
* @note This method could access relative path and absolute path.
|
|
* If the relative path was passed to the vector, FileUtils will add the default resource directory before the relative path.
|
|
* For instance:
|
|
* On Android, the default resource root path is "assets/".
|
|
* If "/mnt/sdcard/" and "resources-large" were set to the search paths vector,
|
|
* "resources-large" will be converted to "assets/resources-large" since it was a relative path.
|
|
*
|
|
* @param searchPaths The array contains search paths.
|
|
* @see fullPathForFilename(const char*)
|
|
* @since v2.1
|
|
* In js:var setSearchPaths(var jsval);
|
|
* @lua NA
|
|
*/
|
|
virtual void setSearchPaths(const std::vector<std::string>& searchPaths);
|
|
|
|
/**
|
|
* Add search path.
|
|
*
|
|
* @since v2.1
|
|
*/
|
|
void addSearchPath(const std::string & path, const bool front=false);
|
|
|
|
/**
|
|
* Gets the array of search paths.
|
|
*
|
|
* @return The array of search paths.
|
|
* @see fullPathForFilename(const char*).
|
|
* @lua NA
|
|
*/
|
|
virtual const std::vector<std::string>& getSearchPaths() const;
|
|
|
|
/**
|
|
* Gets the writable path.
|
|
* @return The path that can be write/read a file in
|
|
*/
|
|
virtual std::string getWritablePath() const = 0;
|
|
|
|
/**
|
|
* Sets/Gets whether to pop-up a message box when failed to load an image.
|
|
*/
|
|
virtual void setPopupNotify(bool notify);
|
|
virtual bool isPopupNotify();
|
|
|
|
/**
|
|
* Converts the contents of a file to a ValueMap.
|
|
* @note This method is used internally.
|
|
*/
|
|
virtual ValueMap getValueMapFromFile(const std::string& filename);
|
|
|
|
/**
|
|
* Converts the contents of a file to a ValueMap.
|
|
* @note This method is used internally.
|
|
*/
|
|
virtual ValueMap getValueMapFromData(const char* filedata, int filesize);
|
|
|
|
/**
|
|
* Write a ValueMap to a plist file.
|
|
* @note This method is used internally.
|
|
*/
|
|
virtual bool writeToFile(ValueMap& dict, const std::string& fullPath);
|
|
|
|
/**
|
|
* Converts the contents of a file to a ValueVector.
|
|
* @note This method is used internally.
|
|
*/
|
|
virtual ValueVector getValueVectorFromFile(const std::string& filename);
|
|
|
|
/**
|
|
* Checks whether a file exists.
|
|
*
|
|
* @note If a relative path was passed in, it will be inserted a default root path at the beginning.
|
|
* @param strFilePath The path of the file, it could be a relative or absolute path.
|
|
* @return true if the file exists, otherwise it will return false.
|
|
*/
|
|
virtual bool isFileExist(const std::string& filename) const;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param strPath The path that needs to be checked.
|
|
* @return true if it's an absolute path, otherwise it will return false.
|
|
*/
|
|
virtual bool isAbsolutePath(const std::string& path) const;
|
|
|
|
/**
|
|
* Checks whether the path is a directory
|
|
*
|
|
* @param dirPath The path of the directory, it could be a relative or an absolute path.
|
|
* @return true if the directory exists, otherwise it will return false.
|
|
*/
|
|
virtual bool isDirectoryExist(const std::string& dirPath);
|
|
|
|
/**
|
|
* Creates a directory
|
|
*
|
|
* @param dirPath The path of the directory, it must be an absolute path.
|
|
* @return true if the directory have been created successfully, otherwise it will return false.
|
|
*/
|
|
virtual bool createDirectory(const std::string& dirPath);
|
|
|
|
/**
|
|
* Remove a directory
|
|
*
|
|
* @param dirPath The full path of the directory, it must be an absolute path.
|
|
* @return true if the directory have been removed successfully, otherwise it will return false.
|
|
*/
|
|
virtual bool removeDirectory(const std::string& dirPath);
|
|
|
|
/**
|
|
* Remove a file
|
|
*
|
|
* @param filepath The full path of the file, it must be an absolute path.
|
|
* @return true if the file have been removed successfully, otherwise it will return false.
|
|
*/
|
|
virtual bool removeFile(const std::string &filepath);
|
|
|
|
/**
|
|
* Rename a file under the given directory
|
|
*
|
|
* @param path The parent directory path of the file, it must be an absolute path.
|
|
* @param oldname The current name of the file.
|
|
* @param name The new name of the file.
|
|
* @return true if the file have been renamed successfully, otherwise it will return false.
|
|
*/
|
|
virtual bool renameFile(const std::string &path, const std::string &oldname, const std::string &name);
|
|
|
|
/**
|
|
* Retrieve the file size
|
|
*
|
|
* @note If a relative path was passed in, it will be inserted a default root path at the beginning.
|
|
* @param filepath The path of the file, it could be a relative or absolute path.
|
|
* @return The file size.
|
|
*/
|
|
virtual long getFileSize(const std::string &filepath);
|
|
|
|
/** Returns the full path cache */
|
|
const std::unordered_map<std::string, std::string>& getFullPathCache() const { return _fullPathCache; }
|
|
|
|
protected:
|
|
/**
|
|
* The default constructor.
|
|
*/
|
|
FileUtils();
|
|
|
|
/**
|
|
* 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().
|
|
* @return true if successed, otherwise it returns false.
|
|
*
|
|
*/
|
|
virtual bool init();
|
|
|
|
/**
|
|
* Gets the new filename from the filename lookup dictionary.
|
|
* It is possible to have a override names.
|
|
* @param filename The original filename.
|
|
* @return The new filename after searching in the filename lookup dictionary.
|
|
* If the original filename wasn't in the dictionary, it will return the original filename.
|
|
*/
|
|
virtual std::string getNewFilename(const std::string &filename) const;
|
|
|
|
/**
|
|
* Checks whether a file exists without considering search paths and resolution orders.
|
|
* @param The file (with absolute path) to look up for
|
|
* @return Returns true if the file found at the given absolute path, otherwise returns false
|
|
*/
|
|
virtual bool isFileExistInternal(const std::string& filename) const = 0;
|
|
|
|
/**
|
|
* Checks whether a directory exists without considering search paths and resolution orders.
|
|
* @param The directory (with absolute path) to look up for
|
|
* @return Returns true if the directory found at the given absolute path, otherwise returns false
|
|
*/
|
|
virtual bool isDirectoryExistInternal(const std::string& dirPath) const;
|
|
|
|
/**
|
|
* Gets full path for filename, resolution directory and search path.
|
|
*
|
|
* @param filename The file name.
|
|
* @param resolutionDirectory The resolution directory.
|
|
* @param searchPath The search path.
|
|
* @return The full path of the file. It will return an empty string if the full path of the file doesn't exist.
|
|
*/
|
|
virtual std::string getPathForFilename(const std::string& filename, const std::string& resolutionDirectory, const std::string& searchPath);
|
|
|
|
/**
|
|
* 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.
|
|
* @param strDirectory The directory contains the file we are looking for.
|
|
* @param strFilename The name of the file.
|
|
* @return The full path of the file, if the file can't be found, it will return an empty string.
|
|
*/
|
|
virtual std::string getFullPathForDirectoryAndFilename(const std::string& directory, const std::string& filename);
|
|
|
|
/**
|
|
* Returns the fullpath for a given filename.
|
|
* This is an alternative for fullPathForFilename, there are two main differences:
|
|
* First, it returns empty string instead of the original filename when no file found for the given name.
|
|
* Secondly, it's a const function.
|
|
* @param filename The file name to look up for
|
|
* @return The full path for the file, if not found, the return value will be an empty string
|
|
*/
|
|
virtual std::string searchFullPathForFilename(const std::string& filename) const;
|
|
|
|
|
|
/** Dictionary used to lookup filenames based on a key.
|
|
* It is used internally by the following methods:
|
|
*
|
|
* std::string fullPathForFilename(const char*);
|
|
*
|
|
* @since v2.1
|
|
*/
|
|
ValueMap _filenameLookupDict;
|
|
|
|
/**
|
|
* The vector contains resolution folders.
|
|
* The lower index of the element in this vector, the higher priority for this resolution directory.
|
|
*/
|
|
std::vector<std::string> _searchResolutionsOrderArray;
|
|
|
|
/**
|
|
* The vector contains search paths.
|
|
* The lower index of the element in this vector, the higher priority for this search path.
|
|
*/
|
|
std::vector<std::string> _searchPathArray;
|
|
|
|
/**
|
|
* The default root path of resources.
|
|
* If the default root path of resources needs to be changed, do it in the `init` method of FileUtils's subclass.
|
|
* For instance:
|
|
* On Android, the default root path of resources will be assigned with "assets/" in FileUtilsAndroid::init().
|
|
* Similarly on Blackberry, we assign "app/native/Resources/" to this variable in FileUtilsBlackberry::init().
|
|
*/
|
|
std::string _defaultResRootPath;
|
|
|
|
/**
|
|
* The full path cache. When a file is found, it will be added into this cache.
|
|
* This variable is used for improving the performance of file search.
|
|
*/
|
|
std::unordered_map<std::string, std::string> _fullPathCache;
|
|
|
|
/**
|
|
* The singleton pointer of FileUtils.
|
|
*/
|
|
static FileUtils* s_sharedFileUtils;
|
|
|
|
};
|
|
|
|
// end of platform group
|
|
/// @}
|
|
|
|
NS_CC_END
|
|
|
|
#endif // __CC_FILEUTILS_H__
|