From 1c2007928da2c870470d606bd8c79db3160b7711 Mon Sep 17 00:00:00 2001
From: yyc12345 <yyc12321@outlook.com>
Date: Thu, 11 Jul 2024 09:59:50 +0800
Subject: [PATCH] doc: update documentation for IO helper.

- update IO helper ducumentation.
- fix a latent Linux compile error in IO helper.
---
 doc/src/fs_path_patch.dox |  5 +++++
 doc/src/index.dox         |  4 ++++
 doc/src/io_helper.dox     | 43 +++++++++++++++++++++++++++++++++++++++
 src/IOHelper.cpp          |  2 +-
 4 files changed, 53 insertions(+), 1 deletion(-)
 create mode 100644 doc/src/fs_path_patch.dox
 create mode 100644 doc/src/io_helper.dox

diff --git a/doc/src/fs_path_patch.dox b/doc/src/fs_path_patch.dox
new file mode 100644
index 0000000..c0ef102
--- /dev/null
+++ b/doc/src/fs_path_patch.dox
@@ -0,0 +1,5 @@
+/**
+
+\page fs_path_patch std::filesystem::path Patch
+
+*/
diff --git a/doc/src/index.dox b/doc/src/index.dox
index 06c8813..0b6231b 100644
--- a/doc/src/index.dox
+++ b/doc/src/index.dox
@@ -37,6 +37,10 @@
 
     \li \subpage string_helper
 
+    \li \subpage io_helper
+
+    \li \subpage fs_path_patch
+
     <B>Advanced Features</B>
 
     \li \subpage config_manager
diff --git a/doc/src/io_helper.dox b/doc/src/io_helper.dox
new file mode 100644
index 0000000..fffcb96
--- /dev/null
+++ b/doc/src/io_helper.dox
@@ -0,0 +1,43 @@
+/**
+
+\page io_helper IO Helper
+
+YYCC::IOHelper currently only has one function and one macro.
+
+\section io_helper__ptr_pri_padding Pointer Print Padding
+
+When printing pointer on screen, programmer usually left-pad zero to make it looks good.
+However, the count of zero for padding is different in x86 and x64 architecture (8 for x86 and 16 for x64).
+Macro \c PRI_XPTR_LEFT_PADDING will help you to resolve this issue.
+
+Macro \c PRI_XPTR_LEFT_PADDING will be defined to following value according to the target system architecture.
+
+\li \c "08": On x86 system.
+\li \c "016": On x64 system.
+
+There is an example for how to use it:
+
+\code
+void* raw_ptr = blabla();
+std::printf(stdout, "Raw Pointer 0x%" PRI_XPTR_LEFT_PADDING PRIXPTR, raw_ptr);
+\endcode
+
+Note \c PRIXPTR is defined by standard library for formatting pointer as hexadecimal style.
+
+\section io_helper__utf8_fopen UTF8 fopen
+
+In Windows, standard \c std::fopen can not handle UTF8 file name in common environment.
+So we create this function to give programmer an universal \c fopen in UTF8 style.
+
+In Windows platform, this function will try to convert its argument to \c wchar_t
+and calling Microsoft specific \c _wfopen function to open file.
+If encoding convertion or \c _wfopen failed, this function will return \c nullptr like \c std::fopen does.
+In other platforms, it will simply redirect calling to \c std::fopen.
+
+There is a simple example:
+
+\code
+FILE* fs = YYCC::IOHelper::FOpen(YYCC_U8("/path/to/file"), YYCC_U8("rb"));
+\endcode
+
+*/
\ No newline at end of file
diff --git a/src/IOHelper.cpp b/src/IOHelper.cpp
index 6c7d57e..5c91672 100644
--- a/src/IOHelper.cpp
+++ b/src/IOHelper.cpp
@@ -28,7 +28,7 @@ namespace YYCC::IOHelper {
 		return _wfopen(wpath.c_str(), wmode.c_str());
 
 #else
-		return std::fopen(u8_filepath, u8_mode);
+		return std::fopen(EncodingHelper::ToOrdinary(u8_filepath), EncodingHelper::ToOrdinary(u8_mode));
 #endif
 	}