base.hpp

Go to the documentation of this file.

#pragma once
 
#include <memory>  // For std::unique_ptr
#include <string>  // For std::string
#include <vector>  // For std::vector
 
#include <cpp-toolbox/file/file.hpp>
 
namespace toolbox::io
{
 
class base_file_data_t
{
public:
  virtual ~base_file_data_t() =
      default;  // 虚析构函数对基类很重要 / Virtual destructor is important for
                // base classes
  // Rule of Five/Zero: 如果定义了虚析构函数,需要考虑其他特殊成员函数 / If a
  // virtual destructor is defined, consider the others
  // 由于这个类没有需要特殊管理的资源,使用默认实现即可 / Since this class has no
  // resources needing special management, default is fine
  base_file_data_t(const base_file_data_t&) = default;
  base_file_data_t& operator=(const base_file_data_t&) = default;
  base_file_data_t(base_file_data_t&&) = default;
  base_file_data_t& operator=(base_file_data_t&&) = default;
 
protected:
  base_file_data_t() =
      default;  // 只允许派生类构造 / Allow construction only by derived classes
};
 
class base_file_format_t
{
public:
  virtual ~base_file_format_t() = default;
  // 这个类可能是无状态的或通过RAII管理资源(如派生类中的unique_ptr) / This class
  // is likely stateless or manages resources via RAII
  // 默认的拷贝/移动操作可能没问题,但删除它们更安全 / Default copy/move
  // operations are probably fine, but deleting them is safer
  base_file_format_t(const base_file_format_t&) =
      delete;  // 通常格式处理器不需要拷贝 / Typically format handlers are not
               // copied
  base_file_format_t& operator=(const base_file_format_t&) = delete;
  base_file_format_t(base_file_format_t&&) =
      default;  // 移动可能是可以的 / Moving might be okay
  base_file_format_t& operator=(base_file_format_t&&) = default;
 
  [[nodiscard]] virtual auto can_read(const std::string& path) const
      -> bool = 0;
 
  [[nodiscard]] virtual auto get_supported_extensions() const
      -> std::vector<std::string> = 0;
 
  virtual auto read(const std::string& path,
                    std::unique_ptr<base_file_data_t>& data) -> bool = 0;
 
  [[nodiscard]] virtual auto write(
      const std::string& path,
      const std::unique_ptr<base_file_data_t>& data,
      bool binary) const -> bool = 0;
 
protected:
  base_file_format_t() = default;
};
 
}  // namespace toolbox::io