mirror of https://github.com/axmolengine/axmol.git
116 lines
4.0 KiB
C++
116 lines
4.0 KiB
C++
/****************************************************************************
|
|
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 "CCPlatformMacros.h"
|
|
#include "ccTypes.h"
|
|
|
|
NS_CC_BEGIN
|
|
|
|
/**
|
|
* @addtogroup platform
|
|
* @{
|
|
*/
|
|
|
|
//! @brief Helper class to handle file operations
|
|
class CC_DLL CCFileUtils
|
|
{
|
|
public:
|
|
static CCFileUtils* sharedFileUtils();
|
|
static void purgeFileUtils();
|
|
|
|
void purgeCachedEntries();
|
|
/**
|
|
@brief Get resource file data
|
|
@param[in] pszFileName The resource file name which contain the path
|
|
@param[in] pszMode The read mode of the file
|
|
@param[out] pSize If get the file data succeed the it will be the data size,or it will be 0
|
|
@return if success,the pointer of data will be returned,or NULL is returned
|
|
@warning If you get the file data succeed,you must delete[] it after used.
|
|
*/
|
|
unsigned char* getFileData(const char* pszFileName, const char* pszMode, unsigned long * pSize);
|
|
|
|
/**
|
|
@brief Get resource file data from zip file
|
|
@param[in] pszFileName The resource file name which contain the relative path of zip file
|
|
@param[out] pSize If get the file data succeed the it will be the data size,or it will be 0
|
|
@return if success,the pointer of data will be returned,or NULL is returned
|
|
@warning If you get the file data succeed,you must delete[] it after used.
|
|
*/
|
|
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.
|
|
If you have not set the ResourcePath,the function add "/NEWPLUS/TDA_DATA/UserData/" as default.
|
|
You can set ResourcePath by function void setResourcePath(const char *pszResourcePath);
|
|
*/
|
|
const char* fullPathFromRelativePath(const char *pszRelativePath);
|
|
|
|
/// @cond
|
|
const char* fullPathFromRelativeFile(const char *pszFilename, const char *pszRelativeFile);
|
|
/// @endcond
|
|
|
|
/**
|
|
@brief Set the resource directory,we will find resource relative to this directory
|
|
@param pszDirectoryName Relative path to root
|
|
*/
|
|
void setResourceDirectory(const char *pszDirectoryName);
|
|
|
|
/**
|
|
@brief Get the resource directory
|
|
*/
|
|
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)
|
|
{
|
|
}
|
|
|
|
std::string m_obDirectory;
|
|
};
|
|
|
|
// end of platform group
|
|
/// @}
|
|
|
|
NS_CC_END
|
|
|
|
#endif // __CC_FILEUTILS_PLATFORM_H__
|