file.hpp

Go to the documentation of this file.

#ifndef IFW_CTD_FILE_HPP_
#define IFW_CTD_FILE_HPP_

#include <string>

#include "ctd/defines/defines.hpp"


namespace ctd {
namespace file {

typedef enum {
    SYSROOT   = 1,
    INTROOT   = 2,
    DATAROOT  = 4,
    CFGROOT   = 8,
    ROOTS_ALL = (SYSROOT | INTROOT | DATAROOT | CFGROOT),
    CFG_INT_ROOT = (CFGROOT | INTROOT)
} RootType;

const std::string  SYSROOT_STR   = "SYSROOT";
const std::string  INTROOT_STR   = "INTROOT";
const std::string  DATAROOT_STR  = "DATAROOT";
const std::string  CFGROOT_STR   = "CFGROOT";
typedef enum {
    RES_CONFIG     =  1,
    RES_AUDIO      =  2,
    RES_IMAGE      =  4,
    RES_MODEL      =  8,
    RES_DICTIONARY = 16,
    RES_DATA       = 32,
    RES_ALL        = (RES_CONFIG | RES_AUDIO | RES_IMAGE | RES_MODEL |
    RES_DICTIONARY | RES_DATA)
} ResourceType;

const std::string  RES_DIR             = "resource";
const std::string  RES_CONFIG_STR      = "config";
const std::string  RES_AUDIO_STR       = "audio";
const std::string  RES_IMAGE_STR       = "image";
const std::string  RES_MODEL_STR       = "model";
const std::string  RES_DICTIONARY_STR  = "dictionary";
const std::string  RES_DATA_STR        = "data";
std::string RootVarTypeNbToString(const RootType type);

RootType RootVarTypeStringToNb(const std::string& type);

std::string ResDirNbToString(const ResourceType type);

ResourceType ResDirStringToNb(const std::string& type);

std::string ResolvePath(const std::string& filename);

std::string CreateIfwFilename(const std::string& filename,
                              const RootType root,
                              const ResourceType resource,
                              const std::string& extension = "");

std::string CheckAddExtension(const std::string& filename,
                              const std::string& extension);

void RemoveFile(const std::string& filename);

std::string FindFile(const std::string& filename,
                     int32_t roots = ROOTS_ALL,
                     int32_t resources = RES_ALL,
                     const bool exception = true);

std::string LoadFile(const std::string& filename,
                     std::string* complete_filename = NULL,
                     RootType roots = ROOTS_ALL,
                     ResourceType resources = RES_ALL);

void SaveFile(const std::string& filename,
              const std::string& buffer,
              const bool overwrite = true);

} // namespace file
} // namespace ctd


#endif // !IFW_CTD_FILE_HPP_