refactor: rename Native String to Ordinary String.

- rename Native to Ordinary in code and documentation.
- fulfill some documentations.
This commit is contained in:
2024-07-05 10:36:24 +08:00
parent 1c5a85bbb2
commit 65b81f5cfa
9 changed files with 74 additions and 51 deletions

View File

@ -226,7 +226,7 @@ namespace YYCC::ConsoleHelper {
WinConsoleWrite(strl, bIsErr);
#else
// in linux, directly use C function to write.
std::fputs(EncodingHelper::ToNative(strl.c_str()), bIsErr ? stderr : stdout);
std::fputs(EncodingHelper::ToOrdinary(strl.c_str()), bIsErr ? stderr : stdout);
#endif
}

View File

@ -4,7 +4,7 @@
namespace YYCC::EncodingHelper {
#pragma region UTF8 Native Convertion
#pragma region UTF8 Ordinary Convertion
const yycc_char8_t* ToUTF8(const char* src) {
return reinterpret_cast<const yycc_char8_t*>(src);
@ -19,16 +19,16 @@ namespace YYCC::EncodingHelper {
return yycc_u8string_view(reinterpret_cast<const yycc_char8_t*>(src.data()), src.size());
}
const char* ToNative(const yycc_char8_t* src) {
const char* ToOrdinary(const yycc_char8_t* src) {
return reinterpret_cast<const char*>(src);
}
char* ToNative(yycc_char8_t* src) {
char* ToOrdinary(yycc_char8_t* src) {
return reinterpret_cast<char*>(src);
}
std::string ToNative(const yycc_u8string_view& src) {
std::string ToOrdinary(const yycc_u8string_view& src) {
return std::string(reinterpret_cast<const char*>(src.data()), src.size());
}
std::string_view ToNativeView(const yycc_u8string_view& src) {
std::string_view ToOrdinaryView(const yycc_u8string_view& src) {
return std::string_view(reinterpret_cast<const char*>(src.data()), src.size());
}
@ -176,7 +176,7 @@ return ret;
#pragma region UTF8ToWchar
bool UTF8ToWchar(const yycc_u8string_view& src, std::wstring& dst) {
std::string_view adapted_src(ToNativeView(src));
std::string_view adapted_src(ToOrdinaryView(src));
return CharToWchar(adapted_src, dst, CP_UTF8);
}
bool UTF8ToWchar(const yycc_char8_t* src, std::wstring& dst) {

View File

@ -58,10 +58,10 @@ namespace YYCC::EncodingHelper {
yycc_u8string ToUTF8(const std::string_view& src);
yycc_u8string_view ToUTF8View(const std::string_view& src);
const char* ToNative(const yycc_char8_t* src);
char* ToNative(yycc_char8_t* src);
std::string ToNative(const yycc_u8string_view& src);
std::string_view ToNativeView(const yycc_u8string_view& src);
const char* ToOrdinary(const yycc_char8_t* src);
char* ToOrdinary(yycc_char8_t* src);
std::string ToOrdinary(const yycc_u8string_view& src);
std::string_view ToOrdinaryView(const yycc_u8string_view& src);
#if YYCC_OS == YYCC_OS_WINDOWS

View File

@ -122,7 +122,7 @@ namespace YYCC::ExceptionHelper {
if (fs != nullptr) {
va_list arg1;
va_start(arg1, fmt);
std::vfprintf(fs, EncodingHelper::ToNative(fmt), arg1);
std::vfprintf(fs, EncodingHelper::ToOrdinary(fmt), arg1);
std::fputs("\n", fs);
va_end(arg1);
}
@ -145,7 +145,7 @@ namespace YYCC::ExceptionHelper {
static void UExceptionErrLogWriteLine(std::FILE* fs, const yycc_char8_t* strl) {
// write to file
if (fs != nullptr) {
std::fputs(EncodingHelper::ToNative(strl), fs);
std::fputs(EncodingHelper::ToOrdinary(strl), fs);
std::fputs("\n", fs);
}
// write to stderr

View File

@ -18,7 +18,7 @@ namespace YYCC::FsPathPatch {
return std::filesystem::path(wpath);
#else
return std::filesystem::path(EncodingHelper::ToNative(u8_path));
return std::filesystem::path(EncodingHelper::ToOrdinary(u8_path));
#endif
}

View File

@ -16,13 +16,13 @@ namespace YYCC::ParserHelper {
template<typename _Ty, std::enable_if_t<std::is_floating_point_v<_Ty>, int> = 0>
bool TryParse(const yycc_u8string_view& strl, _Ty& num) {
auto [ptr, ec] = std::from_chars(
EncodingHelper::ToNative(strl.data()),
EncodingHelper::ToNative(strl.data() + strl.size()),
EncodingHelper::ToOrdinary(strl.data()),
EncodingHelper::ToOrdinary(strl.data() + strl.size()),
num, std::chars_format::general
);
if (ec == std::errc()) {
// check whether the full string is matched
return ptr == EncodingHelper::ToNative(strl.data() + strl.size());
return ptr == EncodingHelper::ToOrdinary(strl.data() + strl.size());
} else if (ec == std::errc::invalid_argument) {
// given string is invalid
return false;
@ -37,13 +37,13 @@ namespace YYCC::ParserHelper {
template<typename _Ty, std::enable_if_t<std::is_integral_v<_Ty> && !std::is_same_v<_Ty, bool>, int> = 0>
bool TryParse(const yycc_u8string_view& strl, _Ty& num, int base = 10) {
auto [ptr, ec] = std::from_chars(
EncodingHelper::ToNative(strl.data()),
EncodingHelper::ToNative(strl.data() + strl.size()),
EncodingHelper::ToOrdinary(strl.data()),
EncodingHelper::ToOrdinary(strl.data() + strl.size()),
num, base
);
if (ec == std::errc()) {
// check whether the full string is matched
return ptr == EncodingHelper::ToNative(strl.data() + strl.size());
return ptr == EncodingHelper::ToOrdinary(strl.data() + strl.size());
} else if (ec == std::errc::invalid_argument) {
// given string is invalid
return false;
@ -76,8 +76,8 @@ namespace YYCC::ParserHelper {
yycc_u8string ToString(_Ty num) {
std::array<yycc_char8_t, 64> buffer;
auto [ptr, ec] = std::to_chars(
EncodingHelper::ToNative(buffer.data()),
EncodingHelper::ToNative(buffer.data() + buffer.size()),
EncodingHelper::ToOrdinary(buffer.data()),
EncodingHelper::ToOrdinary(buffer.data() + buffer.size()),
num
);
if (ec == std::errc()) {

View File

@ -25,7 +25,7 @@ namespace YYCC::StringHelper {
int count = std::vsnprintf(
nullptr,
0,
EncodingHelper::ToNative(format),
EncodingHelper::ToOrdinary(format),
args1
);
if (count < 0) {
@ -40,9 +40,9 @@ namespace YYCC::StringHelper {
// however std::vsnprintf already have a trailing NULL, so we plus 1 for it.
strl.resize(count);
int write_result = std::vsnprintf(
EncodingHelper::ToNative(strl.data()),
EncodingHelper::ToOrdinary(strl.data()),
strl.size() + 1,
EncodingHelper::ToNative(format),
EncodingHelper::ToOrdinary(format),
args2
);
va_end(args2);