file.hpp

浏览该文件的文档.

/*
 * @Description: 文件工具函数 头文件及其实现
 * @Version:
 * @Autor: dreamy-xay
 * @date: 2023-12-14
 * @LastEditors: dreamy-xay
 * @LastEditTime: 2024-05-18
 */
 
#ifndef COMMON_UTILS_FILE_HPP
#define COMMON_UTILS_FILE_HPP
 
#include <string>
 
#include "common/base/list.hpp"
 
#if defined(__linux__)
#include <dirent.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#elif defined(_WIN32) || defined(_WIN64)
#include <Windows.h>
#include <direct.h>
#endif
 
#include "common/enum.h"
#include "common/macro.h"
#include "common/type.h"
 
/* declare */
namespace cm {
 
bool IsExist(const char* path);
bool IsFolder(const char* path);
bool IsFile(const char* path);
bool CreateFolder(const char* path);
bool DeleteFolder(const char* path);
 
struct DirectoryInfo {
    List<std::string> files;
    List<std::string> directories;
};
 
DirectoryInfo ListDirectory(const char* path);
 
}  // namespace cm
 
/* implement */
namespace cm {
 
inline bool IsExist(const char* path) {
    // 判断操作系统，只有 Linux 和 Windows 支持标准库中的文件/文件夹存在检查
#if defined(__linux__)
    // Linux 下使用 stat 函数获取文件/文件夹信息
    struct stat buffer;
    return (stat(path, &buffer) == 0);  // 若调用成功则返回 true，否则返回 false
 
#elif defined(_WIN32) || defined(_WIN64)
    // Windows 下使用 GetFileAttributesA 函数获取文件/文件夹属性
    DWORD attributes = GetFileAttributesA(path);
    return (attributes != INVALID_FILE_ATTRIBUTES);  // 若调用成功则返回 true，否则返回 false
 
#else
    // 不支持的系统，抛出异常
    throw Exception("This function does not support the operating system");
 
#endif
}
 
inline bool IsFolder(const char* path) {
    // 判断操作系统，只有 Linux 和 Windows 支持标准库中的文件/文件夹存在检查
#if defined(__linux__)
    struct stat info;
    if (stat(path, &info) != 0)
        throw std::runtime_error("Path does not exist!");
    return S_ISDIR(info.st_mode);
 
#elif defined(_WIN32) || defined(_WIN64)
    DWORD attr = GetFileAttributesA(path);
    if (attr == INVALID_FILE_ATTRIBUTES)
        throw std::runtime_error("Path does not exist!");
    return (attr & FILE_ATTRIBUTE_DIRECTORY) != 0;
 
#else
    // 不支持的系统，抛出异常
    throw Exception("This function does not support the operating system");
 
#endif
}
 
inline bool IsFile(const char* path) {
    // 判断操作系统，只有 Linux 和 Windows 支持标准库中的文件/文件夹存在检查
#if defined(__linux__)
    struct stat info;
    if (stat(path, &info) != 0) 
        throw std::runtime_error("Path does not exist!");
    return S_ISREG(info.st_mode);
 
#elif defined(_WIN32) || defined(_WIN64)
    DWORD attr = GetFileAttributesA(path);
    if (attr == INVALID_FILE_ATTRIBUTES)
        throw std::runtime_error("Path does not exist!");
    return (attr & FILE_ATTRIBUTE_DIRECTORY) == 0;
 
#else
    // 不支持的系统，抛出异常
    throw Exception("This function does not support the operating system");
 
#endif
}
 
inline bool CreateFolder(const char* path) {
    // 判断路径是否存在
    if (!IsExist(path)) {
        // 判断操作系统，只有 Linux 和 Windows 支持标准库中的创建文件夹操作
#if defined(__linux__)
        // 在 Linux 下使用 mkdir 函数创建文件夹
        // 使用 S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH 参数设置权限为 rwxr-xr-x
        return mkdir(path, S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH) == 0;  // 若调用成功则返回 true，否则返回 false
 
#elif defined(_WIN32) || defined(_WIN64)
        // 在 Windows 下使用 mkdir 函数创建文件夹
        return mkdir(path) == 0;  // 若调用成功则返回 true，否则返回 false
 
#else
        // 不支持的系统，抛出异常
        throw Exception("This function does not support the operating system");
#endif
    }
 
    // 路径已存在，直接返回 true
    return true;
}
 
inline bool DeleteFolder(const char* path) {
    // 判断操作系统，只有 Linux 和 Windows 支持标准库中的文件夹操作
#if defined(__linux__)
    // 打开要删除的文件夹
    DIR* dir = opendir(path);
    if (dir == nullptr)
        return false;  // 打开文件夹失败，返回 false
 
    // 遍历文件夹中的所有文件和子文件夹
    struct dirent* entry;
    while ((entry = readdir(dir)) != nullptr) {
        std::string name = entry->d_name;
 
        // 忽略当前文件夹和上一级文件夹
        if (name == "." || name == "..")
            continue;
 
        // 拼接文件/文件夹全路径
        std::string fullPath = std::string(path) + '/' + name;
        struct stat st;
        // 获取文件/文件夹信息
        if (lstat(fullPath.c_str(), &st) == -1)
            continue;
 
        // 如果是文件夹，递归调用 DeleteFolder 函数删除子文件夹及其内容
        if (S_ISDIR(st.st_mode)) {
            if (!DeleteFolder(fullPath.c_str())) {  // 子文件夹删除失败
                closedir(dir);
                return false;
            }
 
        } else {
            // 如果是文件，使用 unlink 函数删除
            if (unlink(fullPath.c_str()) == -1) {
                closedir(dir);
                return false;
            }
        }
    }
 
    // 关闭文件夹
    closedir(dir);
 
    // 删除空文件夹
    return rmdir(path) != -1;
 
#elif defined(_WIN32) || defined(_WIN64)
    // Windows 下使用 RemoveDirectoryA 函数删除文件夹
    return RemoveDirectoryA(path) != 0;
 
#else
    // 不支持的系统，抛出异常
    throw Exception("This function does not support the operating system");
 
#endif
}
 
inline DirectoryInfo ListDirectory(const char* path) {
    DirectoryInfo dir_info;
 
    // 判断路径是否存在
    if (!IsExist(path))
        return dir_info;
 
        // 判断操作系统，只有 Linux 和 Windows 支持标准库中的文件夹操作
#if defined(__linux__)
    DIR* dir = opendir(path);
    if (dir) {
        struct dirent* entry;
        while ((entry = readdir(dir)) != nullptr) {
            if (strcmp(entry->d_name, ".") == 0 || strcmp(entry->d_name, "..") == 0)
                continue;
 
            if (entry->d_type == DT_DIR)
                dir_info.directories.emplace_back(entry->d_name);
            else if (entry->d_type == DT_REG)
                dir_info.files.emplace_back(entry->d_name);
        }
 
        closedir(dir);
    }
#elif defined(_WIN32) || defined(_WIN64)
    std::string search_path = path;
    search_path += +"\\*.*";
    WIN32_FIND_DATA file_data;
    HANDLE hFind = FindFirstFile(search_path.c_str(), &file_data);
 
    if (hFind != INVALID_HANDLE_VALUE) {
        do {
            if (strcmp(file_data.cFileName, ".") == 0 || strcmp(file_data.cFileName, "..") == 0)
                continue;
 
            if (file_data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
                result.directories.emplace_back(file_data.cFileName);
            else
                result.files.emplace_back(file_data.cFileName);
        } while (FindNextFile(hFind, &file_data));
 
        FindClose(hFind);
    }
#else
    // 不支持的系统，抛出异常
    throw Exception("This function does not support the operating system");
 
#endif
 
    // 排序
    dir_info.files.Sort();
    dir_info.directories.Sort();
 
    return std::move(dir_info);
}
 
}  // namespace cm
 
#endif