--------------------------------
-- @module FileUtils
-- @parent_module cc
--------------------------------
-- 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
-- @function [parent=#FileUtils] fullPathForFilename
-- @param self
-- @param #string filename
-- @return string#string ret (return value: string)
--------------------------------
-- Gets string from a file.
-- @function [parent=#FileUtils] getStringFromFile
-- @param self
-- @param #string filename
-- @return string#string ret (return value: string)
--------------------------------
-- Sets the filenameLookup dictionary.
-- param pFilenameLookupDict The dictionary for replacing filename.
-- since v2.1
-- @function [parent=#FileUtils] setFilenameLookupDictionary
-- @param self
-- @param #map_table filenameLookupDict
--------------------------------
-- 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.
-- @function [parent=#FileUtils] removeFile
-- @param self
-- @param #string filepath
-- @return bool#bool ret (return value: bool)
--------------------------------
-- 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.
-- @function [parent=#FileUtils] isAbsolutePath
-- @param self
-- @param #string path
-- @return bool#bool ret (return value: bool)
--------------------------------
-- 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.
-- @function [parent=#FileUtils] renameFile
-- @param self
-- @param #string path
-- @param #string oldname
-- @param #string name
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Loads the filenameLookup dictionary from the contents of a filename.
-- note The plist file name should follow the format below:
-- code
--
--
--
--
-- filenames
--
-- sounds/click.wav
-- sounds/click.caf
-- sounds/endgame.wav
-- sounds/endgame.caf
-- sounds/gem-0.wav
-- sounds/gem-0.caf
--
-- metadata
--
-- version
-- 1
--
--
--
-- endcode
-- param filename The plist file name.
-- since v2.1
-- js loadFilenameLookup
-- lua loadFilenameLookup
-- @function [parent=#FileUtils] loadFilenameLookupDictionaryFromFile
-- @param self
-- @param #string filename
--------------------------------
--
-- @function [parent=#FileUtils] isPopupNotify
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Converts the contents of a file to a ValueVector.
-- note This method is used internally.
-- @function [parent=#FileUtils] getValueVectorFromFile
-- @param self
-- @param #string filename
-- @return array_table#array_table ret (return value: array_table)
--------------------------------
-- Gets the array of search paths.
-- return The array of search paths.
-- see fullPathForFilename(const char*).
-- lua NA
-- @function [parent=#FileUtils] getSearchPaths
-- @param self
-- @return array_table#array_table ret (return value: array_table)
--------------------------------
-- Write a ValueMap to a plist file.
-- note This method is used internally.
-- @function [parent=#FileUtils] writeToFile
-- @param self
-- @param #map_table dict
-- @param #string fullPath
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Converts the contents of a file to a ValueMap.
-- note This method is used internally.
-- @function [parent=#FileUtils] getValueMapFromFile
-- @param self
-- @param #string filename
-- @return map_table#map_table ret (return value: map_table)
--------------------------------
-- Converts the contents of a file to a ValueMap.
-- note This method is used internally.
-- @function [parent=#FileUtils] getValueMapFromData
-- @param self
-- @param #char filedata
-- @param #int filesize
-- @return map_table#map_table ret (return value: map_table)
--------------------------------
-- 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.
-- @function [parent=#FileUtils] removeDirectory
-- @param self
-- @param #string dirPath
-- @return bool#bool ret (return value: bool)
--------------------------------
-- 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
-- @function [parent=#FileUtils] setSearchPaths
-- @param self
-- @param #array_table searchPaths
--------------------------------
-- 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.
-- @function [parent=#FileUtils] getFileSize
-- @param self
-- @param #string filepath
-- @return long#long ret (return value: long)
--------------------------------
-- 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
-- @function [parent=#FileUtils] setSearchResolutionsOrder
-- @param self
-- @param #array_table searchResolutionsOrder
--------------------------------
-- Append search order of the resources.
-- see setSearchResolutionsOrder(), fullPathForFilename().
-- since v2.1
-- @function [parent=#FileUtils] addSearchResolutionsOrder
-- @param self
-- @param #string order
-- @param #bool front
--------------------------------
-- Add search path.
-- since v2.1
-- @function [parent=#FileUtils] addSearchPath
-- @param self
-- @param #string path
-- @param #bool front
--------------------------------
-- 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.
-- @function [parent=#FileUtils] isFileExist
-- @param self
-- @param #string filename
-- @return bool#bool ret (return value: bool)
--------------------------------
-- 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.
-- @function [parent=#FileUtils] purgeCachedEntries
-- @param self
--------------------------------
-- 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. )
-- @function [parent=#FileUtils] fullPathFromRelativeFile
-- @param self
-- @param #string filename
-- @param #string relativeFile
-- @return string#string ret (return value: string)
--------------------------------
-- Sets/Gets whether to pop-up a message box when failed to load an image.
-- @function [parent=#FileUtils] setPopupNotify
-- @param self
-- @param #bool notify
--------------------------------
-- 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.
-- @function [parent=#FileUtils] isDirectoryExist
-- @param self
-- @param #string dirPath
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Gets the array that contains the search order of the resources.
-- see setSearchResolutionsOrder(const std::vector&), fullPathForFilename(const char*).
-- since v2.1
-- lua NA
-- @function [parent=#FileUtils] getSearchResolutionsOrder
-- @param self
-- @return array_table#array_table ret (return value: array_table)
--------------------------------
-- 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.
-- @function [parent=#FileUtils] createDirectory
-- @param self
-- @param #string dirPath
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Gets the writable path.
-- return The path that can be write/read a file in
-- @function [parent=#FileUtils] getWritablePath
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
-- Destroys the instance of FileUtils.
-- @function [parent=#FileUtils] destroyInstance
-- @param self
--------------------------------
-- Gets the instance of FileUtils.
-- @function [parent=#FileUtils] getInstance
-- @param self
-- @return FileUtils#FileUtils ret (return value: cc.FileUtils)
return nil