YYCCommonplace/src/YYCC/IOHelper.hpp

#pragma once
#include "YYCCInternal.hpp"

#include <cstdio>
#include <filesystem>

/**
 * @brief Some IO related stuff
 * @details
 * See also \ref io_helper.
*/
namespace YYCC::IOHelper {
	
#if UINTPTR_MAX == UINT32_MAX
#define PRI_XPTR_LEFT_PADDING "08"
#elif UINTPTR_MAX == UINT64_MAX
	/**
	 * @brief The left-padding zero format string of HEX-printed pointer type.
	 * @details
	 * When printing a pointer with HEX style, we always hope it can be left-padded with some zero for easy reading.
	 * In different architecture, the size of this padding is differnet too so we create this macro.
	 * 
	 * In 32-bit environment, it will be "08" meaning left pad zero until 8 number position.
	 * In 64-bit environment, it will be "016" meaning left pad zero until 16 number position.
	*/
#define PRI_XPTR_LEFT_PADDING "016"
#else
#error "Not supported pointer size."
#endif
	
	/// @brief C++ standard deleter for std::FILE*
	class StdFileDeleter {
	public:
		StdFileDeleter() {}
		void operator() (std::FILE* ptr) {
			if (ptr != nullptr) {
				std::fclose(ptr);
			}
		}
	};
	/// @brief Smart unique pointer of \c std::FILE*
	using SmartStdFile = std::unique_ptr<std::FILE, StdFileDeleter>;

	/**
	 * @brief The UTF8 version of \c std::fopen.
	 * @param[in] u8_filepath The UTF8 encoded path to the file to be opened.
	 * @param[in] u8_mode UTF8 encoded mode string of the file to be opened.
	 * @remarks
	 * This function is suit for Windows because std::fopen do not support UTF8 on Windows.
	 * On other platforms, this function will delegate request directly to std::fopen.
	 * @return \c FILE* of the file to be opened, or nullptr if failed.
	*/
	std::FILE* UTF8FOpen(const yycc_char8_t* u8_filepath, const yycc_char8_t* u8_mode);
	
}