inout.hpp

浏览该文件的文档.

/*
 * @Description: 输入输出工具 头文件及其实现
 * @Version:
 * @Autor: dreamy-xay
 * @date: 2023-12-14
 * @LastEditors: dreamy-xay
 * @LastEditTime: 2024-03-13
 */
 
#ifndef COMMON_UTILS_INOUT_HPP
#define COMMON_UTILS_INOUT_HPP
 
#include <fstream>
#include <opencv2/core.hpp>
#include <opencv2/imgcodecs.hpp>
#include <opencv2/opencv.hpp>
#include <unordered_map>
#include <vector>
 
#include "common/enum.h"
#include "common/macro.h"
#include "common/type.h"
#include "common/utils/file.hpp"
#include "common/utils/string.hpp"
 
namespace cm {
 
template <typename T, typename HASH = EnumHash<T>>
class FileManger {
   private:
    std::unordered_map<T, std::string, HASH> path_table;                               // 文件夹路径表
    std::unordered_map<ImageType, std::string, EnumHash<ImageType>> image_type_table;  // 图片类型表
    std::unordered_map<FileType, std::string, EnumHash<FileType>> file_type_table;     // 文件类型表
 
    std::string output_root_path;  // 输出根路径
 
   public:
    std::string output_file_prefix;
 
    FileManger(const std::string& output_root_path = "", const std::string& output_file_prefix = "");
 
    FileManger<T, HASH>& SetDirectionName(T dir, const std::string& name);
 
    FileManger<T, HASH>& SetDirectionNames(const std::unordered_map<T, std::string, HASH>& names_table);
 
    FileManger<T, HASH>& OutputImage(T dir, const cv::Mat& image, const std::vector<int>& image_params = {}, const std::string& image_name_suffix = "", ImageType type = IMT_JPG);
 
    FileManger<T, HASH>& OutputTextFile(T dir, const std::string& text, const std::string& file_name_suffix = "", FileType type = FT_TXT);
};
 
template <typename T, typename HASH>
inline FileManger<T, HASH>::FileManger(const std::string& output_root_path, const std::string& output_file_prefix) : output_root_path(output_root_path), output_file_prefix(output_file_prefix) {
    // 支持输出图片类型
    image_type_table[IMT_JPG] = "jpg";
    image_type_table[IMT_JPEG] = "jpeg";
    image_type_table[IMT_PNG] = "png";
    image_type_table[IMT_BMP] = "bmp";
    image_type_table[IMT_TIF] = "tif";
    image_type_table[IMT_GIF] = "gif";
 
    // 支持输出文件类型
    file_type_table[FT_TXT] = "txt";
    file_type_table[FT_LOG] = "log";
    file_type_table[FT_JSON] = "json";
    file_type_table[FT_XML] = "xml";
    file_type_table[FT_CSV] = "csv";
}
 
template <typename T, typename HASH>
inline FileManger<T, HASH>& FileManger<T, HASH>::SetDirectionName(T dir, const std::string& name) {
    // 当前文件夹路径
    std::string current_path = path_table[dir] = output_root_path + '/' + name;
 
    // 如果文件夹不存在，则创建文件夹，创建失败则抛出异常
    if (!CreateFolder(current_path.c_str()))
        throw Exception("Failed to create folder.");
 
    return *this;
}
 
template <typename T, typename HASH>
inline FileManger<T, HASH>& FileManger<T, HASH>::SetDirectionNames(const std::unordered_map<T, std::string, HASH>& names_table) {
    // 遍历该表，设置输出文件目录名
    for (auto it = names_table.begin(); it != names_table.end(); ++it)
        this->SetDirectionName(it->first, it->second);
 
    return *this;
}
 
template <typename T, typename HASH>
inline FileManger<T, HASH>& FileManger<T, HASH>::OutputImage(T dir, const cv::Mat& image, const std::vector<int>& image_params, const std::string& image_name_suffix, ImageType type) {
    // 输出图片
    cv::imwrite(Sprintf("%s/%s%s%s.%s", path_table[dir].c_str(), output_file_prefix.c_str(), (image_name_suffix.empty() ? "" : "_"), image_name_suffix.c_str(), image_type_table[type].c_str()), image, image_params);
 
    return *this;
}
 
template <typename T, typename HASH>
inline FileManger<T, HASH>& FileManger<T, HASH>::OutputTextFile(T dir, const std::string& text, const std::string& file_name_suffix, FileType type) {
    // 文件写入流
    std::ofstream ofs;
 
    // 打开文件，不存在则创建
    ofs.open(Sprintf("%s/%s%s%s.%s", path_table[dir].c_str(), output_file_prefix.c_str(), (file_name_suffix.empty() ? "" : "_"), file_name_suffix.c_str(), file_type_table[type].c_str()));  // flawfinder: ignore
 
    // 断言文件是否成功打开
    Cm_Assert(ofs.is_open(), "failed to open the file!!!");
 
    ofs << text;  // 写入数据到文件
    ofs.close();  // 关闭文件流
 
    return *this;
}
 
}  // namespace cm
 
#endif