axmol/cocos2dx/platform/CCFileUtils.h

/****************************************************************************
Copyright (c) 2010 cocos2d-x.org

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_PLATFORM_H__
#define __CC_FILEUTILS_PLATFORM_H__

#include <string>
#include <vector>
#include "CCPlatformMacros.h"
#include "ccTypes.h"
#include "ccTypeInfo.h"

NS_CC_BEGIN

class CCDictionary;
class CCArray;
/**
 * @addtogroup platform
 * @{
 */

//! @brief  Helper class to handle file operations
class CC_DLL CCFileUtils : public TypeInfo
{
public:
    /**
     *  Returns an unique ID for this class.
     *  @note It's only used for JSBindings now.
     *  @return The unique ID for this class.
     */
    virtual long getClassTypeInfo() {
		static const long id = cocos2d::getHashCodeByString(typeid(cocos2d::CCFileUtils).name());
		return id;
    }
    
    /**
     *  Gets the instance of CCFileUtils.
     */
    static CCFileUtils* sharedFileUtils();
    
    /**
     *  Destroys the instance of CCFileUtils.
     */
    static void purgeFileUtils();
    
    /**
     *  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.
     */
    void purgeCachedEntries();
    
    /**
    @brief Get resource file data
    @param[in]  pszFileName 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 delete[] on any Non-NULL pointer returned.
    */
    unsigned char* getFileData(const char* pszFileName, const char* pszMode, unsigned long * pSize);

    /**
    @brief Get resource file data from a zip file.
    @param[in]  pszFileName The resource file name which contains the relative path of the zip 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 delete[] on any Non-NULL pointer returned.
    */
    unsigned char* getFileDataFromZip(const char* pszZipFilePath, const char* pszFileName, unsigned long * pSize);

    /**
     *  @brief   Generate the absolute path of the file.
     *  @param   pszRelativePath     The relative path of the file.
     *  @return  The absolute path of the file.
     *  @warning We only add the ResourcePath before the relative path of the file.
     *  @deprecated Please use fullPathForFilename instead.
     *
     */
    CC_DEPRECATED_ATTRIBUTE const char* fullPathFromRelativePath(const char *pszRelativePath);
    
    /** 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 obtain the full path of the filename using the CCFileUtils 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("external_dir/", "internal_dir/") to search paths vector by setSearchPaths,
     	and set three elements("resources-ipadhd/", "resources-ipad/", "resources-iphonehd")
     	to resolutions vector by setSearchResolutionsOrder.

     	The file (e.g. sprite.png) search order will be:

     	    external_dir/resources-ipadhd/sprite.png     (if not found, search next)
     	    external_dir/resources-ipad/sprite.png       (if not found, search next)
     	    external_dir/resources-iphonehd/sprite.png   (if not found, search next)
     	    external_dir/sprite.png                      (if not found, search next)
     	    internal_dir/resources-ipadhd/sprite.png     (if not found, search next)
     	    internal_dir/resources-ipad/sprite.png       (if not found, search next)
     	    internal_dir/resources-iphonehd/sprite.png   (if not found, search next)
     	    internal_dir/sprite.png                      (if not found, return "sprite.png")

        If the filename contains relative path like "gamescene/uilayer/sprite.png", The file search order will be:

     	    external_dir/gamescene/uilayer/resources-ipadhd/sprite.png     (if not found, search next)
     	    external_dir/gamescene/uilayer/resources-ipad/sprite.png       (if not found, search next)
     	    external_dir/gamescene/uilayer/resources-iphonehd/sprite.png   (if not found, search next)
     	    external_dir/gamescene/uilayer/sprite.png                      (if not found, search next)
     	    internal_dir/gamescene/uilayer/resources-ipadhd/sprite.png     (if not found, search next)
     	    internal_dir/gamescene/uilayer/resources-ipad/sprite.png       (if not found, search next)
     	    internal_dir/gamescene/uilayer/resources-iphonehd/sprite.png   (if not found, search next)
     	    internal_dir/gamescene/uilayer/sprite.png                      (if not found, return "gamescene/sprite.png")

     If the filename can't be found on the file system, it will return the filename directly.
     If the filenameLookup dictionary has been set. It will try to replace the filename with a new filename.
     For example:
     
     * In iOS: "image.png" -> "image.pvr.ccz" -> "search path/resolution dir/image.pvr.ccz"
     *         "gamescene/background.png" -> "gamescene/background.pvr.ccz" -> "search path/gamescene/resolution dir/background.pvr.ccz"
     * In Android: "sounds/click.wav" -> "sounds/click.ogg" -> "search path/sounds/resolution dir/click.ogg"
     
     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 differerent resources for a given file in the different platforms.

     @since v2.1
     */
    std::string fullPathForFilename(const char* pszFileName);
    
    /**
     * Loads the filenameLookup dictionary from the contents of a filename.
     * 
     * @note The plist file name should follow the format below:
     * <?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>
     *
     * @param filename The plist file name.
     *
     @since v2.1
     */
    void loadFilenameLookupDictionaryFromFile(const char* filename);
    
    /** 
     *  Sets the filenameLookup dictionary.
     *
     *  @param pFilenameLookupDict The dictionary for replacing filename.
     *  @since v2.1
     */
    void setFilenameLookupDictionary(CCDictionary* pFilenameLookupDict);
    
    /**
     *  Gets full path from a file name and the path of the reletive file.
     *  @param pszFilename The file name.
     *  @param pszRelativeFile The path of the relative file.
     *  @return The full path.
     *          e.g. pszFilename: 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. )
     *
     */
    const char* fullPathFromRelativeFile(const char *pszFilename, const char *pszRelativeFile);

    /**
     @brief  Set the resource directory; we will find resources relative to this directory.
     @param pszDirectoryName  Relative path to root.
     @deprecated Please use setSearchPaths instead.
    */
    CC_DEPRECATED_ATTRIBUTE void setResourceDirectory(const char *pszDirectoryName);

    /** 
     *  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(), fullPathForFilename().
     *  @since v2.1
     */
    void setSearchResolutionsOrder(const std::vector<std::string>& searchResolutionsOrder);
    
    /**
     *  Gets the array that contains the search order of the resources.
     *
     *  @see setSearchResolutionsOrder(), fullPathForFilename().
     *  @since v2.1
     */
    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.
     *
     *  @param searchPaths The array contains search paths.
     *  @see fullPathForFilename()
     *  @since v2.1
     */
    void setSearchPaths(const std::vector<std::string>& searchPaths);
    
    /**
     *  Gets the array of search paths.
     *  
     *  @return The array of search paths.
     *  @see fullPathForFilename().
     */
    const std::vector<std::string>& getSearchPaths();
    
    /**
     *  Gets the resource directory
     *  @deprecated Please use getSearchPaths() instead.
     */
    CC_DEPRECATED_ATTRIBUTE const char* getResourceDirectory();

    /**
    @brief   Get the writeable path
    @return  The path that can write/read file
    */
    std::string getWriteablePath();

    /**
    @brief Set/Get whether pop-up a message box when the image load failed
    */
    void setPopupNotify(bool bNotify);
    bool isPopupNotify();

protected:
    CCFileUtils(void)
    : m_pFilenameLookupDict(NULL)
    {
    }
    
    bool init();
    
    std::string getNewFilename(const char* pszFileName);
    std::string getPathForFilename(const std::string& filename, const std::string& resourceDirectory, const std::string& searchPath);
    
    std::string m_obDirectory;
    
    /** Dictionary used to lookup filenames based on a key.
     It is used internally by the following methods:
     
     const char* fullPathForFilename(const char* )key;
     
     @since v2.1
     */
    CCDictionary* m_pFilenameLookupDict;
    
    std::vector<std::string> m_searchResolutionsOrderArray;
    std::vector<std::string> m_searchPathArray;
    std::string m_strDefaultResRootPath;
};

// end of platform group
/// @}

NS_CC_END

#endif    // __CC_FILEUTILS_PLATFORM_H__