fix: find iconv if we include it

- remove the bracker (<bla>) in clap test because clap will automatically add it.

.clang-format

@@ -0,0 +1,317 @@
+# yaml-language-server: $schema=https://json.schemastore.org/clang-format.json
+---
+Language:        Cpp
+AccessModifierOffset: -4
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+AlignConsecutiveAssignments:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  AlignFunctionPointers: false
+  PadOperators:    false
+AlignConsecutiveBitFields:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  AlignFunctionPointers: false
+  PadOperators:    false
+AlignConsecutiveDeclarations:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  AlignFunctionPointers: false
+  PadOperators:    false
+AlignConsecutiveMacros:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  AlignFunctionPointers: false
+  PadOperators:    false
+AlignConsecutiveShortCaseStatements:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCaseArrows: false
+  AlignCaseColons: false
+AlignConsecutiveTableGenBreakingDAGArgColons:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  AlignFunctionPointers: false
+  PadOperators:    false
+AlignConsecutiveTableGenCondOperatorColons:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  AlignFunctionPointers: false
+  PadOperators:    false
+AlignConsecutiveTableGenDefinitionColons:
+  Enabled:         false
+  AcrossEmptyLines: false
+  AcrossComments:  false
+  AlignCompound:   false
+  AlignFunctionPointers: false
+  PadOperators:    false
+AlignEscapedNewlines: DontAlign
+AlignOperands:   Align
+AlignTrailingComments:
+  Kind:            Always
+  OverEmptyLines:  0
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowBreakBeforeNoexceptSpecifier: Never
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseExpressionOnASingleLine: true
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortCompoundRequirementOnASingleLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: AllIfsAndElse
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AttributeMacros:
+  - __capability
+BinPackArguments: false
+BinPackParameters: false
+BitFieldColonSpacing: Both
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: Never
+  AfterEnum:       false
+  AfterExternBlock: false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  BeforeCatch:     false
+  BeforeElse:      false
+  BeforeLambdaBody: false
+  BeforeWhile:     false
+  IndentBraces:    false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+BreakAdjacentStringLiterals: true
+BreakAfterAttributes: Leave
+BreakAfterJavaFieldAnnotations: false
+BreakAfterReturnType: None
+BreakArrays:     true
+BreakBeforeBinaryOperators: All
+BreakBeforeConceptDeclarations: Always
+BreakBeforeBraces: Attach
+BreakBeforeInlineASMColon: OnlyMultiline
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: AfterColon
+BreakFunctionDefinitionParameters: false
+BreakInheritanceList: BeforeColon
+BreakStringLiterals: false
+BreakTemplateDeclarations: Yes
+ColumnLimit:     140
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: true
+DisableFormat:   false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - forever
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^<Q.*'
+    Priority:        200
+    SortPriority:    200
+    CaseSensitive:   true
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentAccessModifiers: false
+IndentCaseBlocks: false
+IndentCaseLabels: true
+IndentExternBlock: AfterExternBlock
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentRequiresClause: true
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+InsertBraces:    false
+InsertNewlineAtEOF: false
+InsertTrailingCommas: None
+IntegerLiteralSeparator:
+  Binary:          0
+  BinaryMinDigits: 0
+  Decimal:         0
+  DecimalMinDigits: 0
+  Hex:             0
+  HexMinDigits:    0
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLines:
+  AtEndOfFile:     false
+  AtStartOfBlock:  false
+  AtStartOfFile:   false
+LambdaBodyIndentation: Signature
+LineEnding:      DeriveLF
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MainIncludeChar: Quote
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 4
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PackConstructorInitializers: BinPack
+PenaltyBreakAssignment: 150
+PenaltyBreakBeforeFirstCallParameter: 300
+PenaltyBreakComment: 500
+PenaltyBreakFirstLessLess: 400
+PenaltyBreakOpenParenthesis: 0
+PenaltyBreakScopeResolution: 500
+PenaltyBreakString: 600
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 50
+PenaltyIndentedWhitespace: 0
+PenaltyReturnTypeOnItsOwnLine: 300
+PointerAlignment: Right
+PPIndentWidth:   -1
+QualifierAlignment: Leave
+ReferenceAlignment: Pointer
+ReflowComments:  false
+RemoveBracesLLVM: false
+RemoveParentheses: Leave
+RemoveSemicolon: false
+RequiresClausePosition: OwnLine
+RequiresExpressionIndentation: OuterScope
+SeparateDefinitionBlocks: Leave
+ShortNamespaceLines: 1
+SkipMacroDefinitionBody: false
+SortIncludes: Never
+SortJavaStaticImport: Before
+SortUsingDeclarations: Lexicographic
+SpaceAfterCStyleCast: true
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: false
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeJsonColon: false
+SpaceBeforeParens: ControlStatements
+SpaceBeforeParensOptions:
+  AfterControlStatements: true
+  AfterForeachMacros: true
+  AfterFunctionDefinitionName: false
+  AfterFunctionDeclarationName: false
+  AfterIfMacros:   true
+  AfterOverloadedOperator: false
+  AfterPlacementOperator: true
+  AfterRequiresInClause: false
+  AfterRequiresInExpression: false
+  BeforeNonEmptyParentheses: false
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  Never
+SpacesInContainerLiterals: false
+SpacesInLineCommentPrefix:
+  Minimum:         1
+  Maximum:         -1
+SpacesInParens:  Never
+SpacesInParensOptions:
+  ExceptDoubleParentheses: false
+  InCStyleCasts:   false
+  InConditionalStatements: false
+  InEmptyParentheses: false
+  Other:           false
+SpacesInSquareBrackets: false
+Standard:        Auto
+StatementAttributeLikeMacros:
+  - Q_EMIT
+  - emit
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+  - Q_CLASSINFO
+  - Q_ENUM
+  - Q_ENUM_NS
+  - Q_FLAG
+  - Q_FLAG_NS
+  - Q_GADGET
+  - Q_GADGET_EXPORT
+  - Q_INTERFACES
+  - Q_LOGGING_CATEGORY
+  - Q_MOC_INCLUDE
+  - Q_NAMESPACE
+  - Q_NAMESPACE_EXPORT
+  - Q_OBJECT
+  - Q_PROPERTY
+  - Q_REVISION
+  - Q_DISABLE_COPY
+  - Q_DISABLE_COPY_MOVE
+  - Q_SET_OBJECT_NAME
+  - QT_BEGIN_NAMESPACE
+  - QT_END_NAMESPACE
+  - QML_ADDED_IN_MINOR_VERSION
+  - QML_ANONYMOUS
+  - QML_ATTACHED
+  - QML_DECLARE_TYPE
+  - QML_DECLARE_TYPEINFO
+  - QML_ELEMENT
+  - QML_EXTENDED
+  - QML_EXTENDED_NAMESPACE
+  - QML_EXTRA_VERSION
+  - QML_FOREIGN
+  - QML_FOREIGN_NAMESPACE
+  - QML_IMPLEMENTS_INTERFACES
+  - QML_INTERFACE
+  - QML_NAMED_ELEMENT
+  - QML_REMOVED_IN_MINOR_VERSION
+  - QML_SINGLETON
+  - QML_UNAVAILABLE
+  - QML_UNCREATABLE
+  - QML_VALUE_TYPE
+  - YYCC_DELETE_COPY
+  - YYCC_DELETE_MOVE
+  - YYCC_DELETE_COPY_MOVE
+  - YYCC_DEFAULT_COPY
+  - YYCC_DEFAULT_MOVE
+  - YYCC_DEFAULT_COPY_MOVE
+  - YYCC_DECL_COPY
+  - YYCC_DECL_MOVE
+  - YYCC_DECL_COPY_MOVE
+TableGenBreakInsideDAGArg: DontBreak
+TabWidth:        4
+UseTab:          Never
+VerilogBreakBetweenInstancePorts: true
+WhitespaceSensitiveMacros:
+  - BOOST_PP_STRINGIZE
+  - CF_SWIFT_NAME
+  - NS_SWIFT_NAME
+  - PP_STRINGIZE
+  - STRINGIZE
+...
+

.editorconfig

@@ -0,0 +1,3 @@
+[*.{cpp,hpp}]
+indent_style = space
+indent_size = 4

.github/scripts/README.md

@@ -0,0 +1,4 @@
+# GitHub Action Scripts
+
+These script files are only used for GitHub Action.
+These script files should only be executed in their root directory respectively.

.github/scripts/gbenchmark/linux.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+# Create build and install directory
+mkdir build install
+
+# Build project
+cd build
+cmake -DCMAKE_CXX_STANDARD=23 -DBENCHMARK_ENABLE_TESTING=OFF -DCMAKE_BUILD_TYPE=Release ..
+cmake --build .
+cmake --install . --prefix=../install
+cd ..
+
+# Record install directory
+cd install
+export benchmark_ROOT=$(pwd)
+cd ..

.github/scripts/gbenchmark/macos.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+# Create build and install directory
+mkdir build install
+
+# Build project
+cd build
+cmake -DCMAKE_CXX_STANDARD=23 -DBENCHMARK_ENABLE_TESTING=OFF -DCMAKE_BUILD_TYPE=Release ..
+cmake --build .
+cmake --install . --prefix=../install
+cd ..
+
+# Record install directory
+cd install
+export benchmark_ROOT=$(pwd)
+cd ..

.github/scripts/gbenchmark/windows.bat

@@ -0,0 +1,17 @@
+@ECHO OFF
+
+:: Create build and install directory
+MKDIR build
+MKDIR install
+
+:: Build project
+CD build
+cmake -A x64 -DCMAKE_CXX_STANDARD=23 -DBENCHMARK_ENABLE_TESTING=OFF ..
+cmake --build . --config Release
+cmake --install . --prefix=../install --config Release
+CD ..
+
+:: Record install directory
+CD install
+SET benchmark_ROOT=%CD%
+CD ..

.github/scripts/gtest/linux.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+# Create build and install directory
+mkdir build install
+
+# Build project
+cd build
+cmake -DCMAKE_CXX_STANDARD=23 -Dgtest_force_shared_crt=ON -DCMAKE_BUILD_TYPE=Release ..
+cmake --build .
+cmake --install . --prefix=../install
+cd ..
+
+# Record install directory
+cd install
+export GTest_ROOT=$(pwd)
+cd ..

.github/scripts/gtest/macos.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+# Create build and install directory
+mkdir build install
+
+# Build project
+cd build
+cmake -DCMAKE_CXX_STANDARD=23 -Dgtest_force_shared_crt=ON -DCMAKE_BUILD_TYPE=Release ..
+cmake --build .
+cmake --install . --prefix=../install
+cd ..
+
+# Record install directory
+cd install
+export GTest_ROOT=$(pwd)
+cd ..

.github/scripts/gtest/windows.bat

@@ -0,0 +1,17 @@
+@ECHO OFF
+
+:: Create build and install directory
+MKDIR build
+MKDIR install
+
+:: Build project
+CD build
+cmake -A x64 -DCMAKE_CXX_STANDARD=23 -Dgtest_force_shared_crt=ON  ..
+cmake --build . --config Release
+cmake --install . --prefix=../install --config Release
+CD ..
+
+:: Record install directory
+CD install
+SET GTest_ROOT=%CD%
+CD ..

.github/scripts/linux.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+set -euo pipefail
+
+# Create build directory and enter it
+mkdir bin
+cd bin
+# Create internal build and install directory, then enter it
+mkdir build
+mkdir install
+
+# Build in Release mode
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DYYCC_BUILD_TEST=ON -DGTest_ROOT=$GTest_ROOT -DYYCC_BUILD_BENCHMARK=ON -Dbenchmark_ROOT=$benchmark_ROOT ../..
+cmake --build .
+cmake --install . --prefix=../install
+cd ..
+
+# Back to root directory
+cd ..

.github/scripts/macos.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+set -euo pipefail
+
+# Create build directory and enter it
+mkdir bin
+cd bin
+# Create internal build and install directory, then enter it
+mkdir build
+mkdir install
+
+# Build in Release mode
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DYYCC_BUILD_TEST=ON -DGTest_ROOT=$GTest_ROOT -DYYCC_BUILD_BENCHMARK=ON -Dbenchmark_ROOT=$benchmark_ROOT ../..
+cmake --build .
+cmake --install . --prefix=../install
+cd ..
+
+# Back to root directory
+cd ..

.github/scripts/windows.bat

@@ -0,0 +1,18 @@
+@ECHO OFF
+
+:: Create build directory and enter it
+MKDIR bin
+CD bin
+:: Create internal build and install directory, then enter it
+MKDIR build
+MKDIR install
+
+:: Build with x64 architecture in Release mode
+CD build
+cmake -A x64 -DYYCC_BUILD_TEST=ON -DGTest_ROOT=%GTest_ROOT% -DYYCC_BUILD_BENCHMARK=ON -Dbenchmark_ROOT=%benchmark_ROOT% ../..
+cmake --build . --config Release
+cmake --install . --prefix=../install --config Release
+CD ..
+
+:: Back to root directory
+CD ..

.github/workflows/linux.yml

@@ -0,0 +1,66 @@
+name: YYCC Linux Build
+
+on: [workflow_dispatch]
+
+jobs:
+  linux-build:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+    - name: Install Dependencies
+      shell: bash
+      run: |
+        sudo apt update
+        sudo apt install -y build-essential cmake git
+    - name: Fetch Google Test
+      uses: actions/checkout@v4
+      with:
+        repository: 'google/googletest'
+        ref: 'v1.17.0'
+        path: 'extern/googletest'
+    - name: Build Google Test
+      shell: bash
+      run: |
+        cd extern/googletest
+        # Build Google Test
+        source ../../.github/scripts/gtest/linux.sh
+        # Record environment variable
+        echo "GTest_ROOT=$GTest_ROOT" >> "$GITHUB_ENV"
+        cd ../..
+    - name: Fetch Google Benchmark
+      uses: actions/checkout@v4
+      with:
+        repository: 'google/benchmark'
+        ref: 'v1.9.4'
+        path: 'extern/benchmark'
+    - name: Build Google Benchmark
+      shell: bash
+      run: |
+        cd extern/benchmark
+        # Create symlink to googletest as required by benchmark
+        ln -s ../googletest googletest
+        # Build Google Benchmark
+        source ../../.github/scripts/gbenchmark/linux.sh
+        # Record environment variable
+        echo "benchmark_ROOT=$benchmark_ROOT" >> "$GITHUB_ENV"
+        cd ../..
+    - name: Build YYCC
+      shell: bash
+      run: |
+        source ./.github/scripts/linux.sh
+    - name: Run YYCC Test
+      shell: bash
+      run: |
+        ./bin/install/bin/YYCCTest
+    - name: Run YYCC Benchmark
+      shell: bash
+      run: |
+        ./bin/install/bin/YYCCBenchmark
+    - name: Upload Built Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: YYCC-linux-build
+        path: bin/install/*
+        retention-days: 30

.github/workflows/macos.yml

@@ -0,0 +1,61 @@
+name: YYCC macOS Build
+
+on: [workflow_dispatch]
+
+jobs:
+  macos-build:
+    runs-on: macos-latest
+    
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+    - name: Fetch Google Test
+      uses: actions/checkout@v4
+      with:
+        repository: 'google/googletest'
+        ref: 'v1.17.0'
+        path: 'extern/googletest'
+    - name: Build Google Test
+      shell: bash
+      run: |
+        cd extern/googletest
+        # Build Google Test
+        source ../../.github/scripts/gtest/macos.sh
+        # Record environment variable
+        echo "GTest_ROOT=$GTest_ROOT" >> "$GITHUB_ENV"
+        cd ../..
+    - name: Fetch Google Benchmark
+      uses: actions/checkout@v4
+      with:
+        repository: 'google/benchmark'
+        ref: 'v1.9.4'
+        path: 'extern/benchmark'
+    - name: Build Google Benchmark
+      shell: bash
+      run: |
+        cd extern/benchmark
+        # Create symlink to googletest as required by benchmark
+        ln -s ../googletest googletest
+        # Build Google Benchmark
+        source ../../.github/scripts/gbenchmark/macos.sh
+        # Record environment variable
+        echo "benchmark_ROOT=$benchmark_ROOT" >> "$GITHUB_ENV"
+        cd ../..
+    - name: Build YYCC
+      shell: bash
+      run: |
+        source ./.github/scripts/macos.sh
+    - name: Run YYCC Test
+      shell: bash
+      run: |
+        ./bin/install/bin/YYCCTest
+    - name: Run YYCC Benchmark
+      shell: bash
+      run: |
+        ./bin/install/bin/YYCCBenchmark
+    - name: Upload Built Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: YYCC-macos-build
+        path: bin/install/*
+        retention-days: 30        

.github/workflows/nightly.yml.disabled

@@ -1,35 +0,0 @@
-name: YYCC Nightly Build
-
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - master
-
-jobs:
-  msvc-build:
-  
-    strategy:
-      matrix:
-        vs: ['2019']
-        msvc_arch: ['x86']
-
-    runs-on: windows-2019
-
-    steps:
-    - name: Fetching Repository
-      uses: actions/checkout@v3
-    - name: Building YYCC
-      shell: cmd
-      run: |
-        set VS=${{ matrix.vs }}
-        set VCVARS="C:\Program Files (x86)\Microsoft Visual Studio\%VS%\Enterprise\VC\Auxiliary\Build\vcvarsall.bat"
-        if not exist %VCVARS% set VCVARS="C:\Program Files\Microsoft Visual Studio\%VS%\Enterprise\VC\Auxiliary\Build\vcvarsall.bat"
-        call %VCVARS% ${{ matrix.msvc_arch }}
-        .\script\build.bat
-    - name: Uploading Nightly Build
-      uses: actions/upload-artifact@v3
-      with:
-        name: YYCC-windows-nightly
-        path: bin/install/*
-        retention-days: 30

.github/workflows/windows.yml

@@ -0,0 +1,78 @@
+name: YYCC Windows Build
+
+on: [workflow_dispatch]
+
+jobs:
+  windows-build:
+
+    strategy:
+      matrix:
+        include:
+          - vs: '2022'
+            msvc_arch: 'x64'
+
+    runs-on: windows-2022
+    
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v4
+    - name: Fetch Google Test
+      uses: actions/checkout@v4
+      with:
+        repository: 'google/googletest'
+        ref: 'v1.17.0'
+        path: 'extern/googletest'
+    - name: Build Google Test
+      shell: cmd
+      run: |
+        CD extern\googletest
+        :: Build Google Test
+        CALL ..\..\.github\scripts\gtest\windows.bat
+        :: Idk why I can't use $GITHUB_ENV, so I use this stupid way to do this.
+        :: This is first entry so we override it.
+        ECHO SET GTest_ROOT=%GTest_ROOT% > ..\envs.bat
+        CD ..\..
+    - name: Fetch Google Benchmark
+      uses: actions/checkout@v4
+      with:
+        repository: 'google/benchmark'
+        ref: 'v1.9.4'
+        path: 'extern/benchmark'
+    - name: Build Google Benchmark
+      shell: cmd
+      run: |
+        CD extern\benchmark
+        :: Create symlink to googletest as required by benchmark
+        mklink /D googletest ..\googletest
+        :: Build Google Benchmark
+        CALL ..\..\.github\scripts\gbenchmark\windows.bat
+        :: This is second entry so we append it.
+        ECHO SET benchmark_ROOT=%benchmark_ROOT% >> ..\envs.bat
+        CD ..\..
+    - name: Build YYCC
+      shell: cmd
+      run: |
+        :: Prepare Visual Studio
+        set VS=${{ matrix.vs }}
+        set VCVARS="C:\Program Files (x86)\Microsoft Visual Studio\%VS%\Enterprise\VC\Auxiliary\Build\vcvarsall.bat"
+        if not exist %VCVARS% set VCVARS="C:\Program Files\Microsoft Visual Studio\%VS%\Enterprise\VC\Auxiliary\Build\vcvarsall.bat"
+        call %VCVARS% ${{ matrix.msvc_arch }}
+        :: Extract saved environment variables
+        CALL .\extern\envs.bat
+        :: Build Project
+        CALL .\.github\scripts\windows.bat
+    - name: Run YYCC Test
+      shell: cmd
+      run: |
+        .\bin\install\bin\YYCCTest.exe
+    - name: Run YYCC Benchmark
+      shell: cmd
+      run: |
+        .\bin\install\bin\YYCCBenchmark.exe
+    - name: Upload Built Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: YYCC-windows-build
+        path: bin/install/*
+        retention-days: 30
+        

.gitignore

@@ -1,11 +1,18 @@
-# -------------------- Output --------------------
+## ===== Personal =====
+# Ignore build resources
 out/
+build/
+install/
+extern/
+
+# Ignore CMake generated stuff
+src/yycc/version.hpp
 CMakeSettings.json
 
-# -------------------- VSCode --------------------
+## ===== VSCode =====
 .vscode/
 
-# -------------------- CMake --------------------
+## ===== CMake =====
 CMakeLists.txt.user
 CMakeCache.txt
 CMakeFiles
@@ -18,7 +25,7 @@ compile_commands.json
 CTestTestfile.cmake
 _deps
 
-# -------------------- Visual Studio --------------------
+## ===== Visual Studio =====
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##

CMakeLists.txt

@@ -1,13 +1,19 @@
 cmake_minimum_required(VERSION 3.23)
 project(YYCC
-    VERSION 1.2.0
+    VERSION 2.0.0
     LANGUAGES CXX
 )
 
+# Setup C++ standard
+set(CMAKE_CXX_STANDARD 23)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
 # Provide options
-option(YYCC_BUILD_TESTBENCH "Build testbench of YYCCommonplace." OFF)
+option(YYCC_BUILD_TEST "Build test of YYCCommonplace." OFF)
+option(YYCC_BUILD_BENCHMARK "Build benchmark of YYCCommonplace." OFF)
 option(YYCC_BUILD_DOC "Build document of YYCCommonplace." OFF)
-option(YYCC_DEBUG_UE_FILTER "YYCC developer used switch for testing Windows unhandled exception filter. Should not set to ON!!!" OFF)
+option(YYCC_ENFORCE_ICONV "Enforce iconv support for this library (e.g. in MSYS2 environment)." OFF)
 
 # Setup install path from CMake provided install path for convenient use.
 include(GNUInstallDirs)
@@ -20,10 +26,36 @@ set(YYCC_INSTALL_BIN_PATH ${CMAKE_INSTALL_BINDIR} CACHE PATH
 set(YYCC_INSTALL_DOC_PATH ${CMAKE_INSTALL_DOCDIR} CACHE PATH
 "Non-arch doc install path relative to CMAKE_INSTALL_PREFIX unless set to an absolute path.")
 
-# Import 3 build targets
+# Test charconv support due to shitty clang's libcxx.
+include(${CMAKE_CURRENT_LIST_DIR}/cmake/check_charconv.cmake)
+
+# Include dependency.
+# GTest is required if we build test
+if (YYCC_BUILD_TEST)
+    # For Windows: Prevent overriding the parent project's compiler/linker settings
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    find_package(GTest REQUIRED)
+endif ()
+# Google Benchmark is required if we build benchmark
+if (YYCC_BUILD_BENCHMARK)
+    find_package(benchmark REQUIRED)
+endif ()
+# Doxygen is required if we build doc
+if (YYCC_BUILD_DOC)
+    find_package(Doxygen REQUIRED)
+endif ()
+# Iconv is required if we are not in Windows or user request it
+if (YYCC_ENFORCE_ICONV OR (NOT WIN32))
+    find_package(Iconv REQUIRED)
+endif ()
+
+# Import 4 build targets
 add_subdirectory(src)
-if (YYCC_BUILD_TESTBENCH)
+if (YYCC_BUILD_TEST)
-    add_subdirectory(testbench)
+    add_subdirectory(test)
+endif ()
+if (YYCC_BUILD_BENCHMARK)
+    add_subdirectory(benchmark)
 endif ()
 if (YYCC_BUILD_DOC)
     add_subdirectory(doc)
@@ -46,7 +78,7 @@ write_basic_package_version_file(
 configure_package_config_file(
     ${CMAKE_CURRENT_LIST_DIR}/cmake/YYCCommonplaceConfig.cmake.in 
     "${CMAKE_CURRENT_BINARY_DIR}/YYCCommonplaceConfig.cmake"
-    INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/YYCCommonplace
+    INSTALL_DESTINATION ${YYCC_INSTALL_LIB_PATH}/cmake/YYCCommonplace
 )
 # Copy package files to install destination
 install(
@@ -54,6 +86,6 @@ FILES
     "${CMAKE_CURRENT_BINARY_DIR}/YYCCommonplaceConfig.cmake"
     "${CMAKE_CURRENT_BINARY_DIR}/YYCCommonplaceConfigVersion.cmake"
 DESTINATION
-    ${CMAKE_INSTALL_LIBDIR}/cmake/YYCCommonplace
+    ${YYCC_INSTALL_LIB_PATH}/cmake/YYCCommonplace
 )
 

COMPILE.md

@@ -0,0 +1,185 @@
+# Compile Manual
+
+## Choose Version
+
+This manual is only suit for the version equal or newer than YYCC 2.0.
+For old version, please checkout to corresponding tag and browse how to build them.
+
+We suggest that you only use stable version (tagged commit).
+The latest commit always present current works.
+It means that it is not stable and work in progress.
+
+## Requirements
+
+* CMake 3.23 at least.
+* The common compiler supporting C++ 23 (GCC / Clang / MSVC).
+* Iconv (Optional on Windows. Required on other systems).
+* [Google Test](https://github.com/google/googletest) (Required if you build test).
+* [Google Benchmark](https://github.com/google/benchmark) (Required if you build benchmark).
+* Doxygen (Required if you build documentation).
+
+If you are just want to build this project to make something works, or build other project, rather than code with it,
+you commonly do not need build test, benchmark and documentation.
+So you actually do not need Google Test, Google Benchmark and Doxygen.
+
+## Preparing
+
+### Compiler
+
+> [!WARNING]  
+> You may face some issues when building on macOS with Apple Clang. That's not your fault.
+> Clang and Apple Clang used libc++ library lacks some essential features used by this project.
+> This is especially not good for Apple Clang because Apple Clang is usually behind Clang a bunch of versions.
+> 
+> For resolving this issue, I have written a series of patch header files for libcxx and you can find them in include directory.
+> This project should be compiled on macOS but everything has exception.
+> If you really have this issue, a possible solution is that use GCC and libstdc++ on macOS instead of default Clang and libc++.
+> 
+> Build issue may be resolved until libc++ finish these features: complete `std::from_chars` and `std::to_chars`,
+> `std::stacktrace` and `std::views::enumerate`.
+
+### Google Test
+
+Google Test is required if you need to build test.
+If you don't need this please skip this chapter.
+
+We use Google Test v1.17.0.
+It would be okey use other versions but I have not test on them.
+
+> [!WARNING]  
+> When building this project, you may face link error with Google Test, especially on Linux.
+> This issue is caused by that the binary provided by your package manager is built in C++17 and its ABI is incompatible with C++23.
+> See this [GitHub Issue](https://github.com/google/googletest/issues/4591) for more infomation.
+> The solution is that download Google Test source code and build it in C++23 on your own.
+> Following content tell you how to do this.
+
+There are the steps instructing you how to compile Google Test manually.
+
+1. Download Google Test source code with given version in GitHub Release page.
+1. Extract it into a directory.
+1. Enter this directory and create 2 subdirectory `build` and `install` for CMake build and install respectively.
+1. Enter `build` directory and configure CMake with extra `-DCMAKE_CXX_STANDARD=23 -Dgtest_force_shared_crt=ON` parameters.
+1. Use CMake to build Google Test
+1. Use CMake to install Google Test into previous we created `install` directory.
+
+### Google Benchmark
+
+Google Benchmark is required if you need to build benchmark.
+If you don't need this please skip this chapter.
+
+We use Google Benchmark v1.9.4.
+It would be okey use other versions but I have not test on them.
+
+There are the steps instructing you how to compile Google Benchmark manually.
+
+1. Download Google Benchmark source code with given version in GitHub Release page.
+1. Extract it into a directory.
+1. Enter this directory and create link named `googletest` to previous fetched Google Test root directory. This is instructed by official manual because Google Benchmark rely on Google Test. Link can be create by executing `mklink /D googletest <path-to-googletest-root-dir>` on Windows or `ln -s <path-to-googletest-root-dir> googletest` on POSIX-like OS.
+1. Keep stay in this directory and create 2 subdirectory `build` and `install` for CMake build and install respectively.
+1. Enter `build` directory and configure CMake with extra `-DCMAKE_CXX_STANDARD=23 -DBENCHMARK_ENABLE_TESTING=OFF` parameters.
+1. Use CMake to build Google Benchmark
+1. Use CMake to install Google Benchmark into previous we created `install` directory.
+
+### Iconv
+
+Iconv is optional on Windows and disabled in default.
+However, if you are building project on MSYS2 or MINGW platform in Windows, we suggest you enable Iconv feature for more functions.
+Once you enable this feature, you must prepare installed Iconv which is no problem for MSYS2 environment via package manager.
+You also can enable this feature under MSVC but you must make sure that you can compile Iconv under MSVC.
+For how to enable this feature forcely, see following chapters for more infomations.
+
+On other platforms, Iconv is enabled automatically and can not be disabled.
+Because there is no other encoding convertion libraries that we can use (Windows has a builtin set of encoding convertion Win32 functions).
+
+### Doxygen
+
+Doxygen is required only if you need to build documentation.
+If you don't need this please skip this chapter.
+
+We use Doxygen 1.9.7.
+It would be okey use other versions but I have not test on them.
+
+YYCCommonplace use Doxygen as its documentation system.
+So before compiling, you must make sure `doxygen` are presented in your environment.
+
+## Build and Install
+
+There are 2 different ways to build this project.
+If you are the user of this project (just want this project to make something works, or build other projects), please choose "User Build".
+If you are a developer (developer of this project, or use this project as dependency to develop your project), please choose "Developer Build".
+
+### User Build
+
+"User Build" is basically how GitHub Action build this project.
+
+Under **the root directory** of this project, execute:
+
+- `script/windows_build.bat` on Windows
+- or `script/linux_build.sh` on Linux
+- or `script/macos_build.sh` on macOS
+
+The final built artifact is under `bin/install` directory.
+
+### Developer Build
+
+#### Configurable Variables
+
+First, there is a list listing all variables you may configure during compiling.
+
+* `YYCC_BUILD_TEST`: Set it to `ON` to build test. `OFF` in default.
+It is useful for the developer of this project.
+It also suit for the user who has runtime issues on their platforms to check whether this project works as expected.
+If you are debugging this project to find bug, I suggest that you build this project under Debug mode and use this test project for debugging.
+* `YYCC_BUILD_BENCHMARK`: Set it to `ON` to build benchmark. `OFF` in default.
+It is useful for the developer of this project to checking the performace for those homemade functions.
+It is highly suggested build this project with Release mode to have real benchmark result.
+* `YYCC_BUILD_DOC`: Set it to `ON` to build documentation. `OFF` in default.
+It may be useful for the developer who firstly use this project in their own projects.
+Please note that generated documentation is different in different platforms.
+* `YYCC_ENFORCE_ICONV`: Set it to `ON` to enable Iconv feature forcely. `OFF` in default.
+The usage of this option has been introduced in previous "Iconv" chapter.
+* `GTest_ROOT`: Set to the install path of Google Test
+if you have enable `YYCC_BUILD_TEST` and want to use your personal built Google Test.
+* `benchmark_ROOT`: Set to the install path of Google Benchmark
+if you have enable `YYCC_BUILD_BENCHMARK` and want to use your personal built Google Benchmark.
+* `Iconv_ROOT`: The assistant variable for finding Iconv which is exposed by CMake.
+You usually do not need set it up.
+* `CMAKE_CXX_STANDARD`: Set C++ standard version of project.
+`23` in default and this version can not be lower than C++23.
+You usually do not need change this.
+* `CMAKE_POSITION_INDEPENDENT_CODE`: Set it to `True` to enable PIC.
+This is essential for those project which use this project and produce dynamicing library as final artifact.
+
+#### Configure CMake
+
+When configure CMake, you may use different options on different platforms.
+Following list may help you.
+
+- On Windows:
+    * `-A Win32` or `-A x64` to specify architecture.
+- On Linux or other POSIX systems:
+    * `-DCMAKE_BUILD_TYPE=Debug` or `-DCMAKE_BUILD_TYPE=Release` to specify build type.
+
+Additionally, you can attach any variables introduced above with `-D` option during CMake configurations.
+
+#### Build with CMake
+
+After configuration, you can use `cmake --build .` to build project,
+with additional options on different platforms.
+Following list may help you.
+
+- On Windows:
+    * `--config Debug` or `--config Release` to specify build type.
+- On Linux or other POSIX systems:
+    * None
+
+#### Install with CMake
+
+After building, you can use `cmake --install . --prefix <path-to-prefix>`
+to install project into given path, with additional options on different platforms.
+Following list may help you.
+
+- On Windows:
+    * `--config Debug` or `--config Release` to specify build type.
+- On Linux or other POSIX systems:
+    * None

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024-2024 yyc12345
+Copyright (c) 2024-2026 yyc12345
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,14 +4,9 @@ YYC Commonplace, or YYCCommonplace (abbr. YYCC) is a static library specifically
 
 ## Usage
 
-For more usage about this library, please build documentation of this project via Doxygen and read it.
+For more usage about this library, please read documentation after building this project with documentation.
-
+I also highly recommend that you read documentation first before writing with this library.
-And I also highly recommend that you read documentation first before writing with this library.
-
-However, the documentation need CMake to build and you may don't know how to use CMake in this project. So as the alternative, you also can browse the raw Doxygen documentation file: `doc/src/intro.dox` for how to build this project (including documentation) first.
 
 ## Build
 
-This project require at least CMake 3.23 to build. We suggest that you only use stable version (tagged commit). The latest commit may still work in progress and not stable.
+See [Compile Manual](./COMPILE.md).
-
-See documentation for how to build this project.

asset/.gitignore

@@ -0,0 +1,212 @@
+## ===== Myself =====
+# Exclude VSCode
+.vscode/
+
+## ===== Python =====
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

asset/pycodec/.gitignore

@@ -0,0 +1,2 @@
+# Exclude result
+*.cpp

asset/pycodec/README.md

@@ -0,0 +1,7 @@
+# PyCodec
+
+This directory contain all stuff related to PyCodec.
+
+PyCodec use different encoding system on different OS. In Windows it use Win32 functions, and it will use Iconv in other OS. So we need a table converting PyCodec universal encoding name to Windows Code Page or Iconv Code Name. These relation was stored in CSV file and Python script will render it into C++ source code.
+
+For the format of CSV file, each line is a record. The first item in record is the standard PyCodec name. The second item is corresponding Windows Code Page. If there is no corresponding Code Page, it can be empty. The third item is corresponding Iconv Code Name. It also can be empty with same case. Then, the count of remain columns is variables after forth item (inclusive). All of them is the alias of this standard PyCodec name.

asset/pycodec/conv_encoding_table.py

@@ -0,0 +1,54 @@
+import csv
+from pathlib import Path
+import jinja2
+
+
+class LanguageToken:
+    name: str
+    alias: tuple[str, ...]
+    code_page: str | None
+    iconv_code: str | None
+
+    def __init__(self, row: list[str]):
+        """Init language token from CSV row."""
+        self.name = row[0].lower()
+        code_page = row[1]
+        self.code_page = None if len(code_page) == 0 else code_page
+        iconv_code = row[2]
+        self.iconv_code = None if len(iconv_code) == 0 else iconv_code
+        # For alias, we strip and to lower them first, and remove all empty entries
+        alias = row[3:]
+        self.alias = tuple(
+            filter(lambda x: len(x) != 0,
+                   map(lambda x: x.strip().lower(), alias)))
+
+
+def _get_self_dir() -> Path:
+    return Path(__file__).resolve().parent
+
+
+def _extract_tokens() -> list[LanguageToken]:
+    rv: list[LanguageToken] = []
+    csv_file = _get_self_dir() / 'encoding_table.csv'
+
+    with open(csv_file, 'r', encoding='utf-8', newline='') as f:
+        reader = csv.reader(f, delimiter='\t')
+        for row in reader:
+            rv.append(LanguageToken(row))
+
+    return rv
+
+
+def _render_cpp(tokens: list[LanguageToken]) -> None:
+    loader = jinja2.FileSystemLoader(_get_self_dir())
+    environment = jinja2.Environment(loader=loader)
+    template = environment.get_template('encoding_table.cpp.jinja')
+
+    cpp_file = _get_self_dir() / 'encoding_table.cpp'
+    with open(cpp_file, 'w', encoding='utf-8') as f:
+        f.write(template.render(tokens=tokens))
+
+
+if __name__ == '__main__':
+    tokens = _extract_tokens()
+    _render_cpp(tokens)

asset/pycodec/encoding_table.cpp.jinja

@@ -0,0 +1,23 @@
+static const std::map<std::u8string_view, std::u8string_view> ALIAS_MAP {
+{% for token in tokens -%}
+{% for alias in token.alias -%}
+    { u8"{{ alias }}"sv, u8"{{ token.name }}"sv },
+{% endfor -%}
+{% endfor -%}
+};
+
+static const std::map<std::u8string_view, CodePage> WINCP_MAP {
+{% for token in tokens -%}
+{% if token.code_page is not none -%}
+    { u8"{{ token.name }}"sv, static_cast<CodePage>({{ token.code_page }}u) },
+{% endif -%}
+{% endfor -%}
+};
+
+static const std::map<std::u8string_view, std::string_view> ICONV_MAP {
+{% for token in tokens -%}
+{% if token.iconv_code is not none -%}
+    { u8"{{ token.name }}"sv, "{{ token.iconv_code }}"sv },
+{% endif -%}
+{% endfor -%}
+};

asset/pycodec/encoding_table.csv

@@ -0,0 +1,97 @@
+ascii	437	ASCII	646	us-ascii						
+big5	950	BIG5	big5-tw	csbig5						
+big5hkscs		BIG5-HKSCS	big5-hkscs	hkscs						
+cp037	037		IBM037	IBM039						
+cp273			273	IBM273	csIBM273					
+cp424			EBCDIC-CP-HE	IBM424						
+cp437	437		437	IBM437						
+cp500	500		EBCDIC-CP-BE	EBCDIC-CP-CH	IBM500					
+cp720	720									
+cp737	737									
+cp775	775		IBM775							
+cp850	850	CP850	850	IBM850						
+cp852	852		852	IBM852						
+cp855	855		855	IBM855						
+cp856										
+cp857	857		857	IBM857						
+cp858	858		858	IBM858						
+cp860	860		860	IBM860						
+cp861	861		861	CP-IS	IBM861					
+cp862	862	CP862	862	IBM862						
+cp863	863		863	IBM863						
+cp864	864		IBM864							
+cp865	865		865	IBM865						
+cp866	866	CP866	866	IBM866						
+cp869	869		869	CP-GR	IBM869					
+cp874	874	CP874								
+cp875	875									
+cp932	932	CP932	932	ms932	mskanji	ms-kanji	windows-31j			
+cp949	949	CP949	949	ms949	uhc					
+cp950	950	CP950	950	ms950						
+cp1006										
+cp1026	1026		ibm1026							
+cp1125			1125	ibm1125	cp866u	ruscii				
+cp1140	1140		ibm1140							
+cp1250	1250	CP1250	windows-1250							
+cp1251	1251	CP1251	windows-1251							
+cp1252	1252	CP1252	windows-1252							
+cp1253	1253	CP1253	windows-1253							
+cp1254	1254	CP1254	windows-1254							
+cp1255	1255	CP1255	windows-1255							
+cp1256	1256	CP1256	windows-1256							
+cp1257	1257	CP1257	windows-1257							
+cp1258	1258	CP1258	windows-1258							
+euc_jp	20932	EUC-JP	eucjp	ujis	u-jis					
+euc_jis_2004			jisx0213	eucjis2004						
+euc_jisx0213			eucjisx0213							
+euc_kr	51949	EUC-KR	euckr	korean	ksc5601	ks_c-5601	ks_c-5601-1987	ksx1001	ks_x-1001	
+gb2312	936	CP936	chinese	csiso58gb231280	euc-cn	euccn	eucgb2312-cn	gb2312-1980	gb2312-80	iso-ir-58
+gbk	936	GBK	936	cp936	ms936					
+gb18030	54936	GB18030	gb18030-2000							
+hz	52936	HZ	hzgb	hz-gb	hz-gb-2312					
+iso2022_jp	50220	ISO-2022-JP	csiso2022jp	iso2022jp	iso-2022-jp					
+iso2022_jp_1		ISO-2022-JP-1	iso2022jp-1	iso-2022-jp-1						
+iso2022_jp_2		ISO-2022-JP-2	iso2022jp-2	iso-2022-jp-2						
+iso2022_jp_2004			iso2022jp-2004	iso-2022-jp-2004						
+iso2022_jp_3			iso2022jp-3	iso-2022-jp-3						
+iso2022_jp_ext			iso2022jp-ext	iso-2022-jp-ext						
+iso2022_kr	50225	ISO-2022-KR	csiso2022kr	iso2022kr	iso-2022-kr					
+latin_1	28591	ISO-8859-1	iso-8859-1	iso8859-1	8859	cp819	latin	latin1	L1	
+iso8859_2	28592	ISO-8859-2	iso-8859-2	latin2	L2					
+iso8859_3	28593	ISO-8859-3	iso-8859-3	latin3	L3					
+iso8859_4	28594	ISO-8859-4	iso-8859-4	latin4	L4					
+iso8859_5	28595	ISO-8859-5	iso-8859-5	cyrillic						
+iso8859_6	28596	ISO-8859-6	iso-8859-6	arabic						
+iso8859_7	28597	ISO-8859-7	iso-8859-7	greek	greek8					
+iso8859_8	28598	ISO-8859-8	iso-8859-8	hebrew						
+iso8859_9	28599	ISO-8859-9	iso-8859-9	latin5	L5					
+iso8859_10		ISO-8859-10	iso-8859-10	latin6	L6					
+iso8859_11		ISO-8859-11	iso-8859-11	thai						
+iso8859_13	28603	ISO-8859-13	iso-8859-13	latin7	L7					
+iso8859_14		ISO-8859-14	iso-8859-14	latin8	L8					
+iso8859_15	28605	ISO-8859-15	iso-8859-15	latin9	L9					
+iso8859_16		ISO-8859-16	iso-8859-16	latin10	L10					
+johab	1361	JOHAB	cp1361	ms1361						
+koi8_r										
+koi8_t		KOI8-T								
+koi8_u										
+kz1048			kz_1048	strk1048_2002	rk1048					
+mac_cyrillic	10007	MacCyrillic	maccyrillic							
+mac_greek	10006	MacGreek	macgreek							
+mac_iceland	10079	MacIceland	maciceland							
+mac_latin2			maclatin2	maccentraleurope	mac_centeuro					
+mac_roman		MacRoman	macroman	macintosh						
+mac_turkish	10081	MacTurkish	macturkish							
+ptcp154		PT154	csptcp154	pt154	cp154	cyrillic-asian				
+shift_jis	932	SHIFT_JIS	csshiftjis	shiftjis	sjis	s_jis				
+shift_jis_2004			shiftjis2004	sjis_2004	sjis2004					
+shift_jisx0213			shiftjisx0213	sjisx0213	s_jisx0213					
+utf_32		UTF-32	U32	utf32						
+utf_32_be		UTF-32BE	UTF-32BE							
+utf_32_le		UTF-32LE	UTF-32LE							
+utf_16		UTF16	U16	utf16						
+utf_16_be		UTF-16BE	UTF-16BE							
+utf_16_le		UTF-16LE	UTF-16LE							
+utf_7	65000	UTF-7	U7	unicode-1-1-utf-7						
+utf_8	65001	UTF-8	U8	UTF	utf8	utf-8	cp65001			
+utf_8_sig										

asset/pyproject.toml

@@ -0,0 +1,7 @@
+[project]
+name = "script"
+version = "0.1.0"
+requires-python = ">=3.11"
+dependencies = [
+    "jinja2==3.1.2",
+]

asset/uv.lock

@@ -0,0 +1,74 @@
+version = 1
+revision = 2
+requires-python = ">=3.11"
+
+[[package]]
+name = "jinja2"
+version = "3.1.2"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "markupsafe" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/7a/ff/75c28576a1d900e87eb6335b063fab47a8ef3c8b4d88524c4bf78f670cce/Jinja2-3.1.2.tar.gz", hash = "sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852", size = 268239, upload-time = "2022-04-28T17:21:27.579Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/bc/c3/f068337a370801f372f2f8f6bad74a5c140f6fda3d9de154052708dd3c65/Jinja2-3.1.2-py3-none-any.whl", hash = "sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61", size = 133101, upload-time = "2022-04-28T17:21:25.336Z" },
+]
+
+[[package]]
+name = "markupsafe"
+version = "3.0.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/b2/97/5d42485e71dfc078108a86d6de8fa46db44a1a9295e89c5d6d4a06e23a62/markupsafe-3.0.2.tar.gz", hash = "sha256:ee55d3edf80167e48ea11a923c7386f4669df67d7994554387f84e7d8b0a2bf0", size = 20537, upload-time = "2024-10-18T15:21:54.129Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/6b/28/bbf83e3f76936960b850435576dd5e67034e200469571be53f69174a2dfd/MarkupSafe-3.0.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:9025b4018f3a1314059769c7bf15441064b2207cb3f065e6ea1e7359cb46db9d", size = 14353, upload-time = "2024-10-18T15:21:02.187Z" },
+    { url = "https://files.pythonhosted.org/packages/6c/30/316d194b093cde57d448a4c3209f22e3046c5bb2fb0820b118292b334be7/MarkupSafe-3.0.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:93335ca3812df2f366e80509ae119189886b0f3c2b81325d39efdb84a1e2ae93", size = 12392, upload-time = "2024-10-18T15:21:02.941Z" },
+    { url = "https://files.pythonhosted.org/packages/f2/96/9cdafba8445d3a53cae530aaf83c38ec64c4d5427d975c974084af5bc5d2/MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2cb8438c3cbb25e220c2ab33bb226559e7afb3baec11c4f218ffa7308603c832", size = 23984, upload-time = "2024-10-18T15:21:03.953Z" },
+    { url = "https://files.pythonhosted.org/packages/f1/a4/aefb044a2cd8d7334c8a47d3fb2c9f328ac48cb349468cc31c20b539305f/MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a123e330ef0853c6e822384873bef7507557d8e4a082961e1defa947aa59ba84", size = 23120, upload-time = "2024-10-18T15:21:06.495Z" },
+    { url = "https://files.pythonhosted.org/packages/8d/21/5e4851379f88f3fad1de30361db501300d4f07bcad047d3cb0449fc51f8c/MarkupSafe-3.0.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1e084f686b92e5b83186b07e8a17fc09e38fff551f3602b249881fec658d3eca", size = 23032, upload-time = "2024-10-18T15:21:07.295Z" },
+    { url = "https://files.pythonhosted.org/packages/00/7b/e92c64e079b2d0d7ddf69899c98842f3f9a60a1ae72657c89ce2655c999d/MarkupSafe-3.0.2-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:d8213e09c917a951de9d09ecee036d5c7d36cb6cb7dbaece4c71a60d79fb9798", size = 24057, upload-time = "2024-10-18T15:21:08.073Z" },
+    { url = "https://files.pythonhosted.org/packages/f9/ac/46f960ca323037caa0a10662ef97d0a4728e890334fc156b9f9e52bcc4ca/MarkupSafe-3.0.2-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:5b02fb34468b6aaa40dfc198d813a641e3a63b98c2b05a16b9f80b7ec314185e", size = 23359, upload-time = "2024-10-18T15:21:09.318Z" },
+    { url = "https://files.pythonhosted.org/packages/69/84/83439e16197337b8b14b6a5b9c2105fff81d42c2a7c5b58ac7b62ee2c3b1/MarkupSafe-3.0.2-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:0bff5e0ae4ef2e1ae4fdf2dfd5b76c75e5c2fa4132d05fc1b0dabcd20c7e28c4", size = 23306, upload-time = "2024-10-18T15:21:10.185Z" },
+    { url = "https://files.pythonhosted.org/packages/9a/34/a15aa69f01e2181ed8d2b685c0d2f6655d5cca2c4db0ddea775e631918cd/MarkupSafe-3.0.2-cp311-cp311-win32.whl", hash = "sha256:6c89876f41da747c8d3677a2b540fb32ef5715f97b66eeb0c6b66f5e3ef6f59d", size = 15094, upload-time = "2024-10-18T15:21:11.005Z" },
+    { url = "https://files.pythonhosted.org/packages/da/b8/3a3bd761922d416f3dc5d00bfbed11f66b1ab89a0c2b6e887240a30b0f6b/MarkupSafe-3.0.2-cp311-cp311-win_amd64.whl", hash = "sha256:70a87b411535ccad5ef2f1df5136506a10775d267e197e4cf531ced10537bd6b", size = 15521, upload-time = "2024-10-18T15:21:12.911Z" },
+    { url = "https://files.pythonhosted.org/packages/22/09/d1f21434c97fc42f09d290cbb6350d44eb12f09cc62c9476effdb33a18aa/MarkupSafe-3.0.2-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:9778bd8ab0a994ebf6f84c2b949e65736d5575320a17ae8984a77fab08db94cf", size = 14274, upload-time = "2024-10-18T15:21:13.777Z" },
+    { url = "https://files.pythonhosted.org/packages/6b/b0/18f76bba336fa5aecf79d45dcd6c806c280ec44538b3c13671d49099fdd0/MarkupSafe-3.0.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:846ade7b71e3536c4e56b386c2a47adf5741d2d8b94ec9dc3e92e5e1ee1e2225", size = 12348, upload-time = "2024-10-18T15:21:14.822Z" },
+    { url = "https://files.pythonhosted.org/packages/e0/25/dd5c0f6ac1311e9b40f4af06c78efde0f3b5cbf02502f8ef9501294c425b/MarkupSafe-3.0.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1c99d261bd2d5f6b59325c92c73df481e05e57f19837bdca8413b9eac4bd8028", size = 24149, upload-time = "2024-10-18T15:21:15.642Z" },
+    { url = "https://files.pythonhosted.org/packages/f3/f0/89e7aadfb3749d0f52234a0c8c7867877876e0a20b60e2188e9850794c17/MarkupSafe-3.0.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e17c96c14e19278594aa4841ec148115f9c7615a47382ecb6b82bd8fea3ab0c8", size = 23118, upload-time = "2024-10-18T15:21:17.133Z" },
+    { url = "https://files.pythonhosted.org/packages/d5/da/f2eeb64c723f5e3777bc081da884b414671982008c47dcc1873d81f625b6/MarkupSafe-3.0.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:88416bd1e65dcea10bc7569faacb2c20ce071dd1f87539ca2ab364bf6231393c", size = 22993, upload-time = "2024-10-18T15:21:18.064Z" },
+    { url = "https://files.pythonhosted.org/packages/da/0e/1f32af846df486dce7c227fe0f2398dc7e2e51d4a370508281f3c1c5cddc/MarkupSafe-3.0.2-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:2181e67807fc2fa785d0592dc2d6206c019b9502410671cc905d132a92866557", size = 24178, upload-time = "2024-10-18T15:21:18.859Z" },
+    { url = "https://files.pythonhosted.org/packages/c4/f6/bb3ca0532de8086cbff5f06d137064c8410d10779c4c127e0e47d17c0b71/MarkupSafe-3.0.2-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:52305740fe773d09cffb16f8ed0427942901f00adedac82ec8b67752f58a1b22", size = 23319, upload-time = "2024-10-18T15:21:19.671Z" },
+    { url = "https://files.pythonhosted.org/packages/a2/82/8be4c96ffee03c5b4a034e60a31294daf481e12c7c43ab8e34a1453ee48b/MarkupSafe-3.0.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:ad10d3ded218f1039f11a75f8091880239651b52e9bb592ca27de44eed242a48", size = 23352, upload-time = "2024-10-18T15:21:20.971Z" },
+    { url = "https://files.pythonhosted.org/packages/51/ae/97827349d3fcffee7e184bdf7f41cd6b88d9919c80f0263ba7acd1bbcb18/MarkupSafe-3.0.2-cp312-cp312-win32.whl", hash = "sha256:0f4ca02bea9a23221c0182836703cbf8930c5e9454bacce27e767509fa286a30", size = 15097, upload-time = "2024-10-18T15:21:22.646Z" },
+    { url = "https://files.pythonhosted.org/packages/c1/80/a61f99dc3a936413c3ee4e1eecac96c0da5ed07ad56fd975f1a9da5bc630/MarkupSafe-3.0.2-cp312-cp312-win_amd64.whl", hash = "sha256:8e06879fc22a25ca47312fbe7c8264eb0b662f6db27cb2d3bbbc74b1df4b9b87", size = 15601, upload-time = "2024-10-18T15:21:23.499Z" },
+    { url = "https://files.pythonhosted.org/packages/83/0e/67eb10a7ecc77a0c2bbe2b0235765b98d164d81600746914bebada795e97/MarkupSafe-3.0.2-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:ba9527cdd4c926ed0760bc301f6728ef34d841f405abf9d4f959c478421e4efd", size = 14274, upload-time = "2024-10-18T15:21:24.577Z" },
+    { url = "https://files.pythonhosted.org/packages/2b/6d/9409f3684d3335375d04e5f05744dfe7e9f120062c9857df4ab490a1031a/MarkupSafe-3.0.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:f8b3d067f2e40fe93e1ccdd6b2e1d16c43140e76f02fb1319a05cf2b79d99430", size = 12352, upload-time = "2024-10-18T15:21:25.382Z" },
+    { url = "https://files.pythonhosted.org/packages/d2/f5/6eadfcd3885ea85fe2a7c128315cc1bb7241e1987443d78c8fe712d03091/MarkupSafe-3.0.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:569511d3b58c8791ab4c2e1285575265991e6d8f8700c7be0e88f86cb0672094", size = 24122, upload-time = "2024-10-18T15:21:26.199Z" },
+    { url = "https://files.pythonhosted.org/packages/0c/91/96cf928db8236f1bfab6ce15ad070dfdd02ed88261c2afafd4b43575e9e9/MarkupSafe-3.0.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:15ab75ef81add55874e7ab7055e9c397312385bd9ced94920f2802310c930396", size = 23085, upload-time = "2024-10-18T15:21:27.029Z" },
+    { url = "https://files.pythonhosted.org/packages/c2/cf/c9d56af24d56ea04daae7ac0940232d31d5a8354f2b457c6d856b2057d69/MarkupSafe-3.0.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f3818cb119498c0678015754eba762e0d61e5b52d34c8b13d770f0719f7b1d79", size = 22978, upload-time = "2024-10-18T15:21:27.846Z" },
+    { url = "https://files.pythonhosted.org/packages/2a/9f/8619835cd6a711d6272d62abb78c033bda638fdc54c4e7f4272cf1c0962b/MarkupSafe-3.0.2-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:cdb82a876c47801bb54a690c5ae105a46b392ac6099881cdfb9f6e95e4014c6a", size = 24208, upload-time = "2024-10-18T15:21:28.744Z" },
+    { url = "https://files.pythonhosted.org/packages/f9/bf/176950a1792b2cd2102b8ffeb5133e1ed984547b75db47c25a67d3359f77/MarkupSafe-3.0.2-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:cabc348d87e913db6ab4aa100f01b08f481097838bdddf7c7a84b7575b7309ca", size = 23357, upload-time = "2024-10-18T15:21:29.545Z" },
+    { url = "https://files.pythonhosted.org/packages/ce/4f/9a02c1d335caabe5c4efb90e1b6e8ee944aa245c1aaaab8e8a618987d816/MarkupSafe-3.0.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:444dcda765c8a838eaae23112db52f1efaf750daddb2d9ca300bcae1039adc5c", size = 23344, upload-time = "2024-10-18T15:21:30.366Z" },
+    { url = "https://files.pythonhosted.org/packages/ee/55/c271b57db36f748f0e04a759ace9f8f759ccf22b4960c270c78a394f58be/MarkupSafe-3.0.2-cp313-cp313-win32.whl", hash = "sha256:bcf3e58998965654fdaff38e58584d8937aa3096ab5354d493c77d1fdd66d7a1", size = 15101, upload-time = "2024-10-18T15:21:31.207Z" },
+    { url = "https://files.pythonhosted.org/packages/29/88/07df22d2dd4df40aba9f3e402e6dc1b8ee86297dddbad4872bd5e7b0094f/MarkupSafe-3.0.2-cp313-cp313-win_amd64.whl", hash = "sha256:e6a2a455bd412959b57a172ce6328d2dd1f01cb2135efda2e4576e8a23fa3b0f", size = 15603, upload-time = "2024-10-18T15:21:32.032Z" },
+    { url = "https://files.pythonhosted.org/packages/62/6a/8b89d24db2d32d433dffcd6a8779159da109842434f1dd2f6e71f32f738c/MarkupSafe-3.0.2-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:b5a6b3ada725cea8a5e634536b1b01c30bcdcd7f9c6fff4151548d5bf6b3a36c", size = 14510, upload-time = "2024-10-18T15:21:33.625Z" },
+    { url = "https://files.pythonhosted.org/packages/7a/06/a10f955f70a2e5a9bf78d11a161029d278eeacbd35ef806c3fd17b13060d/MarkupSafe-3.0.2-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:a904af0a6162c73e3edcb969eeeb53a63ceeb5d8cf642fade7d39e7963a22ddb", size = 12486, upload-time = "2024-10-18T15:21:34.611Z" },
+    { url = "https://files.pythonhosted.org/packages/34/cf/65d4a571869a1a9078198ca28f39fba5fbb910f952f9dbc5220afff9f5e6/MarkupSafe-3.0.2-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4aa4e5faecf353ed117801a068ebab7b7e09ffb6e1d5e412dc852e0da018126c", size = 25480, upload-time = "2024-10-18T15:21:35.398Z" },
+    { url = "https://files.pythonhosted.org/packages/0c/e3/90e9651924c430b885468b56b3d597cabf6d72be4b24a0acd1fa0e12af67/MarkupSafe-3.0.2-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c0ef13eaeee5b615fb07c9a7dadb38eac06a0608b41570d8ade51c56539e509d", size = 23914, upload-time = "2024-10-18T15:21:36.231Z" },
+    { url = "https://files.pythonhosted.org/packages/66/8c/6c7cf61f95d63bb866db39085150df1f2a5bd3335298f14a66b48e92659c/MarkupSafe-3.0.2-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d16a81a06776313e817c951135cf7340a3e91e8c1ff2fac444cfd75fffa04afe", size = 23796, upload-time = "2024-10-18T15:21:37.073Z" },
+    { url = "https://files.pythonhosted.org/packages/bb/35/cbe9238ec3f47ac9a7c8b3df7a808e7cb50fe149dc7039f5f454b3fba218/MarkupSafe-3.0.2-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:6381026f158fdb7c72a168278597a5e3a5222e83ea18f543112b2662a9b699c5", size = 25473, upload-time = "2024-10-18T15:21:37.932Z" },
+    { url = "https://files.pythonhosted.org/packages/e6/32/7621a4382488aa283cc05e8984a9c219abad3bca087be9ec77e89939ded9/MarkupSafe-3.0.2-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:3d79d162e7be8f996986c064d1c7c817f6df3a77fe3d6859f6f9e7be4b8c213a", size = 24114, upload-time = "2024-10-18T15:21:39.799Z" },
+    { url = "https://files.pythonhosted.org/packages/0d/80/0985960e4b89922cb5a0bac0ed39c5b96cbc1a536a99f30e8c220a996ed9/MarkupSafe-3.0.2-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:131a3c7689c85f5ad20f9f6fb1b866f402c445b220c19fe4308c0b147ccd2ad9", size = 24098, upload-time = "2024-10-18T15:21:40.813Z" },
+    { url = "https://files.pythonhosted.org/packages/82/78/fedb03c7d5380df2427038ec8d973587e90561b2d90cd472ce9254cf348b/MarkupSafe-3.0.2-cp313-cp313t-win32.whl", hash = "sha256:ba8062ed2cf21c07a9e295d5b8a2a5ce678b913b45fdf68c32d95d6c1291e0b6", size = 15208, upload-time = "2024-10-18T15:21:41.814Z" },
+    { url = "https://files.pythonhosted.org/packages/4f/65/6079a46068dfceaeabb5dcad6d674f5f5c61a6fa5673746f42a9f4c233b3/MarkupSafe-3.0.2-cp313-cp313t-win_amd64.whl", hash = "sha256:e444a31f8db13eb18ada366ab3cf45fd4b31e4db1236a4448f68778c1d1a5a2f", size = 15739, upload-time = "2024-10-18T15:21:42.784Z" },
+]
+
+[[package]]
+name = "script"
+version = "0.1.0"
+source = { virtual = "." }
+dependencies = [
+    { name = "jinja2" },
+]
+
+[package.metadata]
+requires-dist = [{ name = "jinja2", specifier = "==3.1.2" }]

benchmark/CMakeLists.txt

@@ -0,0 +1,33 @@
+# Create executable benchmark
+add_executable(YYCCBenchmark "")
+# Setup test sources
+target_sources(YYCCBenchmark
+PRIVATE
+    main.cpp
+
+    yycc/string/op.cpp
+
+    yycc/carton/fft.cpp
+)
+# target_sources(YYCCBenchmark
+# PRIVATE
+# FILE_SET HEADERS
+# FILES
+#     shared/literals.hpp
+# )
+# Setup headers
+target_include_directories(YYCCBenchmark
+PUBLIC
+    "${CMAKE_CURRENT_LIST_DIR}"
+)
+# Setup libraries
+target_link_libraries(YYCCBenchmark
+PRIVATE
+    YYCCommonplace
+    benchmark::benchmark
+)
+
+# Install binary
+install(TARGETS YYCCBenchmark
+    RUNTIME DESTINATION ${YYCC_INSTALL_BIN_PATH}
+)

benchmark/main.cpp

@@ -0,0 +1,3 @@
+#include <benchmark/benchmark.h>
+
+BENCHMARK_MAIN();

benchmark/yycc/carton/fft.cpp

@@ -0,0 +1,40 @@
+#include <benchmark/benchmark.h>
+#include <yycc.hpp>
+#include <yycc/carton/fft.hpp>
+#include <random>
+#include <chrono>
+
+#define FFT ::yycc::carton::fft
+
+namespace yyccbench::carton::fft {
+
+    using TIndex = size_t;
+    using TFloat = float;
+    using TComplex = std::complex<TFloat>;
+    template<TIndex N>
+    using TFft = FFT::Fft<TIndex, TFloat, N>;
+
+    constexpr TIndex FFT_POINTS = 1024u;
+
+    static void BM_FftCompute(benchmark::State& state) {
+        // prepare random buffer
+        constexpr TIndex RND_BUF_CNT = 8u;
+        std::random_device rnd_device;
+        std::default_random_engine rnd_engine(rnd_device());
+        std::uniform_real_distribution<TFloat> rnd_dist(0.0f, 1.0f);
+        std::vector<std::vector<TComplex>> buffer_collection(RND_BUF_CNT);
+        for (auto& buf : buffer_collection) {
+            buf.resize(FFT_POINTS);
+            std::generate(buf.begin(), buf.end(), [&rnd_engine, &rnd_dist]() mutable -> TComplex { return TComplex(rnd_dist(rnd_engine)); });
+        }
+
+        // prepare FFT engine
+        TFft<FFT_POINTS> fft;
+        // do benchmark
+        for (auto _ : state) {
+            fft.compute(buffer_collection[state.iterations() % RND_BUF_CNT].data());
+        }
+    }
+    BENCHMARK(BM_FftCompute)->Name("FftCompute");
+
+}

benchmark/yycc/string/op.cpp

@@ -0,0 +1,28 @@
+#include <benchmark/benchmark.h>
+#include <yycc.hpp>
+#include <yycc/string/op.hpp>
+
+#define OP ::yycc::string::op
+using namespace std::literals::string_view_literals;
+
+namespace yyccbench::string::op {
+
+    static void BM_StringStrip(benchmark::State& state) {
+        std::u8string_view strl = u8" \thello\r\n"sv, words = u8" \t\r\n"sv;
+        for (auto _ : state) {
+            auto rv = OP::strip(strl, words);
+            benchmark::DoNotOptimize(rv);
+        }
+    }
+    BENCHMARK(BM_StringStrip)->Name("StringStrip");
+
+    static void BM_StringTrim(benchmark::State& state) {
+        std::u8string_view strl = u8" \thello\r\n"sv, words = u8" \t\r\n"sv;
+        for (auto _ : state) {
+            auto rv = OP::trim(strl, words);
+            benchmark::DoNotOptimize(rv);
+        }
+    }
+    BENCHMARK(BM_StringTrim)->Name("StringTrim");
+
+}

cmake/YYCCommonplaceConfig.cmake.in

@@ -1,6 +1,11 @@
 
 @PACKAGE_INIT@
 
+# Find Iconv if we have found it.
+if ("@Iconv_FOUND@")
+    find_package(Iconv REQUIRED)
+endif ()
+
 # Include targets file
 include("${CMAKE_CURRENT_LIST_DIR}/YYCCommonplaceTargets.cmake")
 

cmake/check_charconv.cmake

@@ -0,0 +1,30 @@
+message(STATUS "Checking charconv implementation...")
+include(CheckCXXSourceCompiles)
+
+file(READ "${CMAKE_CURRENT_LIST_DIR}/check_charconv/chars_format.cpp" TEST_CODE_SNIPPET)
+check_cxx_source_compiles("${TEST_CODE_SNIPPET}" YYCC_CHARCONV_HAS_CHARS_FORMAT)
+message(STATUS "Support std::chars_format: ${YYCC_CHARCONV_HAS_CHARS_FORMAT}")
+
+file(READ "${CMAKE_CURRENT_LIST_DIR}/check_charconv/from_chars_result.cpp" TEST_CODE_SNIPPET)
+check_cxx_source_compiles("${TEST_CODE_SNIPPET}" YYCC_CHARCONV_HAS_FROM_CHARS_RESULT)
+message(STATUS "Support std::from_chars_result: ${YYCC_CHARCONV_HAS_FROM_CHARS_RESULT}")
+
+file(READ "${CMAKE_CURRENT_LIST_DIR}/check_charconv/to_chars_result.cpp" TEST_CODE_SNIPPET)
+check_cxx_source_compiles("${TEST_CODE_SNIPPET}" YYCC_CHARCONV_HAS_TO_CHARS_RESULT)
+message(STATUS "Support std::to_chars_result: ${YYCC_CHARCONV_HAS_TO_CHARS_RESULT}")
+
+file(READ "${CMAKE_CURRENT_LIST_DIR}/check_charconv/from_chars_int.cpp" TEST_CODE_SNIPPET)
+check_cxx_source_compiles("${TEST_CODE_SNIPPET}" YYCC_CHARCONV_HAS_FROM_CHARS_INT)
+message(STATUS "Support std::from_chars with integral type: ${YYCC_CHARCONV_HAS_FROM_CHARS_INT}")
+
+file(READ "${CMAKE_CURRENT_LIST_DIR}/check_charconv/from_chars_float.cpp" TEST_CODE_SNIPPET)
+check_cxx_source_compiles("${TEST_CODE_SNIPPET}" YYCC_CHARCONV_HAS_FROM_CHARS_FLOAT)
+message(STATUS "Suppoer std::from_chars with float point type: ${YYCC_CHARCONV_HAS_FROM_CHARS_FLOAT}")
+
+file(READ "${CMAKE_CURRENT_LIST_DIR}/check_charconv/to_chars_int.cpp" TEST_CODE_SNIPPET)
+check_cxx_source_compiles("${TEST_CODE_SNIPPET}" YYCC_CHARCONV_HAS_TO_CHARS_INT)
+message(STATUS "Support std::to_chars with integral type: ${YYCC_CHARCONV_HAS_TO_CHARS_INT}")
+
+file(READ "${CMAKE_CURRENT_LIST_DIR}/check_charconv/to_chars_float.cpp" TEST_CODE_SNIPPET)
+check_cxx_source_compiles("${TEST_CODE_SNIPPET}" YYCC_CHARCONV_HAS_TO_CHARS_FLOAT)
+message(STATUS "Support std::to_chars with float point type: ${YYCC_CHARCONV_HAS_TO_CHARS_FLOAT}")

cmake/check_charconv/chars_format.cpp

@@ -0,0 +1,8 @@
+#include <charconv>
+
+int main(int argc, char **argv) {
+    auto scientific = std::chars_format::scientific;
+    auto fixed = std::chars_format::fixed;
+    auto general = std::chars_format::general;
+    auto hex = std::chars_format::hex;
+}

cmake/check_charconv/from_chars_float.cpp

@@ -0,0 +1,16 @@
+#include <charconv>
+
+int main(int argc, char **argv) {
+    const char probe[] = "0.0";
+    const char* first = probe;
+    const char* last = first + sizeof(probe);
+
+    {
+        float value;
+        auto rv = std::from_chars(first, last, value, std::chars_format::general);
+    }
+    {
+        double value;
+        auto rv = std::from_chars(first, last, value, std::chars_format::general);
+    }
+}

cmake/check_charconv/from_chars_int.cpp

@@ -0,0 +1,41 @@
+#include <charconv>
+#include <cstdint>
+
+int main(int argc, char **argv) {
+    const char probe[] = "0";
+    const char* first = probe;
+    const char* last = first + sizeof(probe);
+
+    {
+        std::int8_t value;
+        auto rv = std::from_chars(first, last, value, 10);
+    }
+    {
+        std::int16_t value;
+        auto rv = std::from_chars(first, last, value, 10);
+    }
+    {
+        std::int32_t value;
+        auto rv = std::from_chars(first, last, value, 10);
+    }
+    {
+        std::int64_t value;
+        auto rv = std::from_chars(first, last, value, 10);
+    }
+    {
+        std::uint8_t value;
+        auto rv = std::from_chars(first, last, value, 10);
+    }
+    {
+        std::uint16_t value;
+        auto rv = std::from_chars(first, last, value, 10);
+    }
+    {
+        std::uint32_t value;
+        auto rv = std::from_chars(first, last, value, 10);
+    }
+    {
+        std::uint64_t value;
+        auto rv = std::from_chars(first, last, value, 10);
+    }
+}

cmake/check_charconv/from_chars_result.cpp

@@ -0,0 +1,9 @@
+#include <charconv>
+#include <system_error>
+
+int main(int argc, char **argv) {
+    std::from_chars_result result {
+        .ptr = nullptr,
+        .ec = std::errc{},
+    };
+}

cmake/check_charconv/to_chars_float.cpp

@@ -0,0 +1,16 @@
+#include <charconv>
+
+int main(int argc, char **argv) {
+    char buffer[1024];
+    char* first = buffer;
+    char* last = first + sizeof(buffer);
+
+    {
+        float value = 0;
+        auto rv = std::to_chars(first, last, value, std::chars_format::general, 6);
+    }
+    {
+        double value = 0;
+        auto rv = std::to_chars(first, last, value, std::chars_format::general, 6);
+    }
+}

cmake/check_charconv/to_chars_int.cpp

@@ -0,0 +1,41 @@
+#include <charconv>
+#include <cstdint>
+
+int main(int argc, char **argv) {
+    char buffer[1024];
+    char* first = buffer;
+    char* last = first + sizeof(buffer);
+
+    {
+        std::int8_t value = 0;
+        auto rv = std::to_chars(first, last, value, 10);
+    }
+    {
+        std::int16_t value = 0;
+        auto rv = std::to_chars(first, last, value, 10);
+    }
+    {
+        std::int32_t value = 0;
+        auto rv = std::to_chars(first, last, value, 10);
+    }
+    {
+        std::int64_t value = 0;
+        auto rv = std::to_chars(first, last, value, 10);
+    }
+    {
+        std::uint8_t value = 0;
+        auto rv = std::to_chars(first, last, value, 10);
+    }
+    {
+        std::uint16_t value = 0;
+        auto rv = std::to_chars(first, last, value, 10);
+    }
+    {
+        std::uint32_t value = 0;
+        auto rv = std::to_chars(first, last, value, 10);
+    }
+    {
+        std::uint64_t value = 0;
+        auto rv = std::to_chars(first, last, value, 10);
+    }
+}

cmake/check_charconv/to_chars_result.cpp

@@ -0,0 +1,9 @@
+#include <charconv>
+#include <system_error>
+
+int main(int argc, char **argv) {
+    std::to_chars_result result {
+        .ptr = nullptr,
+        .ec = std::errc{},
+    };
+}

doc/CMakeLists.txt

@@ -1,13 +1,31 @@
-# Configure Doxygen config file
+# Extract all public macros defined in YYCC
+# However, you should note that these extratcted macros have generator expressions.
+get_target_property(YYCC_COMPILE_DEFINITIONS YYCCommonplace COMPILE_DEFINITIONS)
+if (YYCC_COMPILE_DEFINITIONS STREQUAL "YYCC_COMPILE_DEFINITIONS-NOTFOUND")
+    message(FATAL_ERROR "Cannot extract compile definitions from YYCCommonplace.")
+endif ()
+# Convert list to string for expanding in future.
+list(JOIN YYCC_COMPILE_DEFINITIONS " " YYCC_MACRO_GENERATOR_EXPRESSIONS)
+
+# We simply configure Doxygen config file first.
 configure_file(
     ${CMAKE_CURRENT_LIST_DIR}/Doxyfile.in
     ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
     @ONLY
 )
 
-# Add custom target
+# Then we use "file GENERATE" syntax to generate per-config truely Doxyfile used by Doxygen.
+# Because there is no "$<>" syntax in Doxyfile, so we can safely use it.
+# Please note that the generation of "file GENERATE" syntax will be postponed until the build stage.
+file(GENERATE
+    OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>/Doxyfile"
+    INPUT "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile"
+    TARGET YYCCommonplace
+)
+
+# Add custom target using per-config Doxyfile
 add_custom_target (YYCCDocumentation
-    doxygen ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+    Doxygen::doxygen "${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>/Doxyfile"
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     COMMENT "Generating documentation" VERBATIM
 )

doc/Doxyfile.in

@@ -1031,7 +1031,7 @@ EXCLUDE_SYMBOLS        =
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           = @CMAKE_CURRENT_LIST_DIR@/../testbench
+EXAMPLE_PATH           = @CMAKE_CURRENT_LIST_DIR@/../test
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -2306,7 +2306,7 @@ PERLMOD_MAKEVAR_PREFIX =
 # C-preprocessor directives found in the sources and include files.
 # The default value is: YES.
 
-ENABLE_PREPROCESSING   = NO
+ENABLE_PREPROCESSING   = YES
 
 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
 # in the source code. If set to NO, only conditional compilation will be
@@ -2356,7 +2356,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = YYCC_DOXYGEN
+PREDEFINED             = @YYCC_MACRO_GENERATOR_EXPRESSIONS@
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

doc/src/arg_parser.dox

@@ -1,200 +0,0 @@
-namespace YYCC::ArgParser {
-/**
-
-\page arg_parser Universal Argument Parser
-
-YYCC::ArgParser provides an universal way to parsing command line arguments.
-
-Universal argument parser has similar design with universal config manager,
-it is highly recommand that read \ref config_manager chapter first,
-because you will have a clear understanding of this namespace after reading universal config manager chapter.
-
-There is an example about how to use universal argument parser.
-In following content, we will describe it in detail.
-
-\code{.cpp}
-class TestArgParser {
-public:
-    TestArgParser() :
-        m_IntArgument(YYCC_U8("int"), YYCC_U8_CHAR('i'), YYCC_U8("integral argument"), YYCC_U8("114514")),
-        m_FloatArgument(nullptr, YYCC_U8_CHAR('f'), nullptr, nullptr, true),
-        m_StringArgument(YYCC_U8("string"), YYCC::ArgParser::AbstractArgument::NO_SHORT_NAME, nullptr, nullptr, true),
-        m_BoolArgument(nullptr, YYCC_U8_CHAR('b'), nullptr),
-        m_ClampedFloatArgument(YYCC_U8("clamped-float"), YYCC::ArgParser::AbstractArgument::NO_SHORT_NAME, nullptr, nullptr, true, YYCC::Constraints::GetMinMaxRangeConstraint<float>(-1.0f, 1.0f)),
-        m_OptionContext(YYCC_U8("TestArgParser"), YYCC_U8("This is the testbench of argument parser."), {
-            &m_IntArgument, &m_FloatArgument, &m_StringArgument,
-            &m_BoolArgument, &m_ClampedFloatArgument
-        }) {}
-    ~TestArgParser() {}
-
-    YYCC::ArgParser::NumberArgument<int32_t> m_IntArgument;
-    YYCC::ArgParser::NumberArgument<float> m_FloatArgument;
-    YYCC::ArgParser::StringArgument m_StringArgument;
-
-    YYCC::ArgParser::SwitchArgument m_BoolArgument;
-    YYCC::ArgParser::NumberArgument<float> m_ClampedFloatArgument;
-
-    YYCC::ArgParser::OptionContext m_OptionContext;
-};
-
-// Initialize argument parser.
-TestArgParser test;
-// Get argument list for parsing from standard C main function.
-auto al = YYCC::ArgParser::ArgumentList::CreateFromStd(argc, argv);
-// Start parsing
-test.Parse(al);
-// Get captured string argument
-if (test.m_StringArgument.IsCaptured())
-    auto val = test.m_StringArgument.Get();
-\endcode
-
-These code can resolve following command line:
-
-\code{.sh}
-exec -i 114514 -f 2.0 --string fuck -b --clamped-float 0.5
-\endcode
-
-For convenience, we define following terms used in this article.
-
-\li Every items in command line: Argument.
-\li \c -i, \c --clamped-float: \b Switch / \b Option. the argument starts with dash or double dash.
-\li \c 114514: \b Value. the value of switch.
-
-\section arg_parser__argument Argument
-
-Argument is the leaf of argument parser.
-It has the same position as setting in universal config manager.
-
-\subsection arg_parser__argument__presets Argument Presets
-
-Like setting in universal config manager,
-we also provide various common used argument presets.
-Current'y we support following argument presets:
-
-\li NumberArgument: The argument storing arithmetic type (except \c bool) inside. Such as <TT>-i 114514</TT> in example.
-\li StringArgument: The argument storing string inside. Such as <TT>--string fuck</TT> in example.
-\li SwitchArgument: The argument storing nothing. It is just a simple switch. Such as <TT>-b</TT> in example.
-
-When constructing these argument,
-you need provide one from long name or short name, or both of them.
-Short name is the argument starting with dash and long name starts with double dash.
-You don't need add dash or double dash prefix when providing these names.
-Please note only ASCII characters, which can be displayed on screen, can be used in these names.
-
-Optionally, you can provide description when constructing,
-which will tell user how this switch does and more infomation about this switch.
-And, you can add an example to tell user which value is valid.
-
-Next, you can specify an argument to be optional.
-Optional argument can be absent in command line.
-Oppositely, non-optional argument must be presented in command line,
-otherwise parser will return false to indicate an error.
-For checking whether an optional argument is specified,
-please call AbstractArgument::IsCaptured().
-
-Last, you can optionally assign a constraint to it,
-to help argument limit its value.
-
-However SwitchArgument must be optional argument.
-Because it is true if user specify it explicit it,
-and will be false if user do not give this flag.
-SwitchArgument doesn't have constraint features,
-because it doesn't store any value inside.
-Thus no need to limit this.
-
-\subsection arg_parser__argument__custom Custom Argument
-
-In most cases, the combination use of argument presets and constraints is enough.
-However, if you still are urge to create your personal argument,
-please inherit AbstractArgument and implement essential class functions.
-For the class functions you need to implement,
-please refer to our argument presets.
-
-\section arg_parser__argument_list Argument List
-
-Argument list is a struct used by parser for parsing.
-It is a higher wrapper of a simple list containing argument items.
-We provide 2 ways to get argument list.
-
-\li ArgumentList::CreateFromStd: Create argument list from standard C main function parameters.
-\li ArgumentList::CreateFromWin32: Create argument list from Win32 functions in Windows.
-You should use this function in Windows instead of ArgumentList::CreateFromStd.
-Because the command line passed in standard C main function has encoding issue in Windows.
-Use this function you will fetch correct argument list especially command including non-ASCII characters.
-
-Please note the first argument in given command line will be stripped.
-Because in most cases it point to the executable self,
-and should not be seen as the part of argument list.
-
-\section arg_parser__option_context Option Context
-
-Please note any unknow argument will let the parser return false.
-This is different with other argument parsers.
-In other common argument parsers, 
-they will collect all unknow argument as positional argument, 
-or just simply ignore them.
-
-OptionContext also will not add \c -h or \c --help switch automatically.
-This is also differnent with other parsers.
-You should manually add it.
-However, OptionContext provide a universal help print function, OptionContext::Help.
-You can directly call it to output help text if you needed (fail to parse or user order help).
-
-\section arg_parser__limitation Limitation
-
-This universal argument parser is a tiny parser.
-It only just fulfill my personal requirements.
-So it only accepts limited command line syntax.
-In following content I will tell you some syntaxes which this parser \b not accept.
-
-\subsection arg_parser__limitation__flag_combination Flag Combination
-
-\code{.sh}
-exec -l -s -h
-exec -lsh
-\endcode
-
-Parser accept first line but not accept the second line.
-You must write these flags independently.
-
-\subsection arg_parser__limitation__equal_symbol Equal Symbol
-
-\code{.sh}
-exec --value 114514
-exec --value=114514
-exec --value:114514
-\endcode
-
-Parser only accept first line command.
-You can not use equal symbol or any other symbol to assign value for specified argument.
-You must write value after the argument immediately please.
-
-\subsection arg_parser__limitation__variable_argument Variable Argument
-
-\code{.sh}
-exec -DSOME_VARABLE=SOME_VALUE
-exec -D SOME_VARIABLE=SOME_VALUE
-\endcode
-
-Parser only accept second line.
-However you nned to write a custom argument or constraint to holding this value.
-
-\subsection arg_parser__limitation__switch_dependency Switch Dependency
-
-\code{.sh}
-exec --action-a --action-b
-\endcode
-
-For command line written above,
-if you hope \c --action-a and \c --action-b is exclusive,
-or \c --action-b only be valid if \c --action-a specified,
-you should manually implement this.
-Parser don't have such features to process this switch dependency.
-
-The thing you need to do is set these switches are \b not optional.
-And after parser do a success parsing,
-manually calling AbstractArgument::IsCaptured to fetch whether corresponding switches are captured,
-then do your personal dependency check.
-
-*/
-}

doc/src/carton/binstore.dox

@@ -0,0 +1,208 @@
+namespace yycc::carton::binstore {
+/**
+
+\page binstore Binary Settings Storage (Binstore)
+
+The binstore module provides a binary settings storage system that allows
+applications to persistently store and retrieve configuration settings in
+a binary format. It includes functionality for type-safe serialization and deserialization,
+setting management with unique tokens for access control, version control with migration strategies,
+and comprehensive error handling.
+
+\section binstore__overview Overview
+
+The binstore module consists of several key components:
+
+\li types: Basic types and error handling for the module
+\li serdes: Serialization/deserialization functionality for different data types
+\li setting: Management of settings with name-based lookup and token-based access
+\li configuration: Version and settings collection management
+\li storage: Main storage class for loading/saving settings to/from files or streams
+
+\section binstore__example Example Usage
+
+Here is a complete example showing how to use the binstore module:
+
+\code{.cpp}
+#include <yycc.hpp>
+#include <yycc/carton/binstore.hpp>
+#include <yycc/patch/stream.hpp>
+#include <iostream>
+#include <fstream>
+
+using namespace yycc::carton::binstore;
+using namespace yycc::patch::stream;
+
+enum class LogLevel : uint8_t { Debug, Info, Warning, Error };
+
+int main() {
+    // Create settings collection
+    auto settings = setting::SettingCollection();
+    auto int_setting_token = settings.add_setting(setting::Setting(u8"max_connections"));
+    auto float_setting_token = settings.add_setting(setting::Setting(u8"timeout"));
+    auto string_setting_token = settings.add_setting(setting::Setting(u8"server_address"));
+    auto bool_setting_token = settings.add_setting(setting::Setting(u8"enable_logging"));
+    auto enum_setting_token = settings.add_setting(setting::Setting(u8"log_level"));
+    
+    // Create configuration with version 1
+    auto config = configuration::Configuration(1, std::move(settings));
+    
+    // Create storage with the configuration
+    auto storage = storage::Storage(std::move(config));
+    
+    // Using appropriate SerDes types for different data types
+    using IntSerDes = serdes::IntegralSerDes<int32_t>;
+    using FloatSerDes = serdes::FloatingPointSerDes<float>;
+    using StringSerDes = serdes::StringSerDes;
+    using BoolSerDes = serdes::BoolSerDes<true>;  // true as default value
+    using EnumSerDes = serdes::EnumSerDes<LogLevel, LogLevel::Info>;
+    
+    // Set values
+    storage.set_value<IntSerDes>(int_setting_token, 100);
+    storage.set_value<FloatSerDes>(float_setting_token, 2.5f);
+    storage.set_value<StringSerDes>(string_setting_token, u8"localhost");
+    storage.set_value<BoolSerDes>(bool_setting_token, true);
+    storage.set_value<EnumSerDes>(enum_setting_token, LogLevel::Debug);
+    
+    // Save to file
+    if (auto result = storage.save_into_file("config.bin"); result.has_value()) {
+        std::cout << "Configuration saved successfully" << std::endl;
+    } else {
+        std::cout << "Failed to save configuration" << std::endl;
+    }
+    
+    // Load from file
+    auto new_config = configuration::Configuration(1, setting::SettingCollection());
+    auto new_storage = storage::Storage(std::move(new_config));
+    
+    if (auto result = new_storage.load_from_file("config.bin", storage::LoadStrategy::MigrateOld); result.has_value()) {
+        std::cout << "Configuration loaded successfully" << std::endl;
+        
+        // Get values
+        int32_t max_conn = new_storage.get_value<IntSerDes>(int_setting_token);
+        float timeout = new_storage.get_value<FloatSerDes>(float_setting_token);
+        std::u8string addr = new_storage.get_value<StringSerDes>(string_setting_token);
+        bool logging = new_storage.get_value<BoolSerDes>(bool_setting_token);
+        LogLevel level = new_storage.get_value<EnumSerDes>(enum_setting_token);
+        
+        std::cout << "Max connections: " << max_conn << std::endl;
+        std::cout << "Timeout: " << timeout << std::endl;
+        std::cout << "Server address: " << addr << std::endl;
+        std::cout << "Logging enabled: " << (logging ? "yes" : "no") << std::endl;
+        std::cout << "Log level: " << static_cast<int>(level) << std::endl;
+    } else {
+        std::cout << "Failed to load configuration" << std::endl;
+    }
+    
+    return 0;
+}
+\endcode
+
+\section binstore__components Components
+
+\subsection binstore__settings Settings Management
+
+Settings are identified by unique names and accessed via tokens. The [SettingCollection](\ref setting::SettingCollection)
+manages a collection of settings and ensures no duplicates.
+
+\subsection binstore__configuration Configuration
+
+The [Configuration](\ref configuration::Configuration) class holds the version identifier and the collection of settings.
+Version control is crucial for handling configuration migration between application versions.
+
+\subsection binstore__storage Storage
+
+The [Storage](\ref storage::Storage) class is the main interface for setting/getting values and loading/saving configurations.
+It provides methods for both file-based and stream-based operations.
+
+\subsection binstore__serdes Serialization/Deserialization
+
+SerDes (Serializer/Deserializer) classes handle type-safe conversion between values and their binary representation.
+Built-in SerDes types include:
+
+\li Integral types ([IntegralSerDes](\ref serdes::IntegralSerDes))
+\li Floating-point types ([FloatingPointSerDes](\ref serdes::FloatingPointSerDes))
+\li String types ([StringSerDes](\ref serdes::StringSerDes))
+\li Boolean types ([BoolSerDes](\ref serdes::BoolSerDes))
+\li Enum types ([EnumSerDes](\ref serdes::EnumSerDes))
+
+For some of them, you can specify value range and default value via template parameters.
+
+\section binstore__load_strategies Load Strategies
+
+The binstore module provides different strategies for handling version mismatches:
+
+\li [OnlyCurrent](\ref storage::LoadStrategy::OnlyCurrent): Only accept configurations with matching version
+\li [MigrateOld](\ref storage::LoadStrategy::MigrateOld): Accept matching and older versions, reject newer versions
+\li [AcceptAll](\ref storage::LoadStrategy::AcceptAll): Accept all versions (not recommended for production)
+
+\section binstore__custom_serdes Custom SerDes
+
+Custom SerDes (Serializer/Deserializer) can be created by implementing the \c SerDes concept. 
+A valid SerDes must satisfy the following requirements:
+
+\li Have a type alias called \c ValueType indicating the corresponding setting type
+\li Have a member function called \c serialize that accepts a const reference of the setting data and returns \c ByteArray 
+or \c std::nullopt if serialization fails.
+\li Have a member function called \c deserialize that converts \c ByteArray to the desired type 
+or returns \c std::nullopt if deserialization fails.
+\li Have a member function called \c reset that returns a default \c ByteArray value.
+
+Here is an example of a custom SerDes for storing IPv4 addresses:
+
+\code{.cpp}
+#include <cstdint>
+#include <cstring>
+
+struct IPv4Address {
+    std::uint8_t octets[4];
+    
+    IPv4Address() : octets{0, 0, 0, 0} {}
+    IPv4Address(std::uint8_t a, std::uint8_t b, std::uint8_t c, std::uint8_t d) {
+        octets[0] = a; octets[1] = b; octets[2] = c; octets[3] = d;
+    }
+};
+
+struct IPv4SerDes {
+    using ValueType = IPv4Address;
+    static constexpr size_t VALUE_SIZE = sizeof(IPv4Address); // 4 octets
+    
+    std::optional<types::ByteArray> serialize(const ValueType& value) const {
+        types::ByteArray ba;
+        ba.resize_data(VALUE_SIZE);
+        std::memcpy(ba.get_data_ptr(), value.octets, VALUE_SIZE);
+        return ba;
+    }
+    
+    std::optional<ValueType> deserialize(const types::ByteArray& ba) const {
+        if (ba.get_data_size() != VALUE_SIZE) return std::nullopt;
+        
+        ValueType value;
+        std::memcpy(value.octets, ba.get_data_ptr(), VALUE_SIZE);
+        return value;
+    }
+    
+    types::ByteArray reset() const {
+        // Reset to local address
+        ValueType default_value(127, 0, 0, 1);
+        return this->serialize(default_value).value();
+    }
+};
+\endcode
+
+To use the custom SerDes:
+
+\code{.cpp}
+// Add setting to collection
+auto ip_setting_token = settings.add_setting(setting::Setting(u8"server_ip"));
+
+// Use custom SerDes
+IPv4SerDes ip_serdes;
+storage.set_value<IPv4SerDes>(ip_setting_token, IPv4Address(192, 168, 1, 1));
+
+// Retrieve value
+IPv4Address ip_addr = storage.get_value<IPv4SerDes>(ip_setting_token);
+\endcode
+
+*/
+}

doc/src/carton/clap.dox

@@ -0,0 +1,187 @@
+namespace yycc::carton::clap {
+/**
+
+\page clap Command Line Argument Parser (CLAP)
+
+Command Line Argument Parser (CLAP) module for handling command line arguments and environment variables.
+This module provides a comprehensive system for defining, parsing, and validating command line
+arguments and environment variables. It includes components for defining application metadata,
+command line options, variables, and utilities for parsing and validation.
+
+\section clap__overview Overview
+
+The CLAP module consists of several key components:
+
+\li Types: Error types and result types used throughout the module
+\li Validator: Type-safe validation for command line argument values
+\li Option: Command line options with short and long names
+\li Variable: Environment variables that can be captured
+\li Summary: Application metadata (name, version, author, description)
+\li Application: Complete application definition with options and variables
+\li Manual: Help and version information generation
+\li Parser: Command line argument parsing functionality
+\li Resolver: Environment variable resolution functionality
+
+\section clap__example Example Usage
+
+Here is a complete example showing how to use the CLAP module:
+
+\code{.cpp}
+#include <yycc.hpp>
+#include <yycc/carton/clap.hpp>
+#include <yycc/patch/stream.hpp>
+#include <iostream>
+
+using namespace yycc::carton::clap;
+using namespace yycc::patch::stream;
+
+// Define an application with options and variables
+int main(int argc, char* argv[]) {
+    // Create application summary
+    auto summary = summary::Summary(u8"MyApp", u8"author", u8"1.0.0", u8"A sample application");
+    
+    // Create options collection
+    auto options = option::OptionCollection();
+    auto int_opt = options.add_option(option::Option(u8"i", u8"int", u8"NUM", u8"integral argument"));
+    auto float_opt = options.add_option(option::Option(u8"f", std::nullopt, u8"NUM", u8"floating point argument"));
+    auto string_opt = options.add_option(option::Option(std::nullopt, u8"string", u8"STR", u8"string argument"));
+    auto flag_opt = options.add_option(option::Option(u8"v", std::nullopt, std::nullopt, u8"verbose mode"));
+    
+    // Create variables collection
+    auto variables = variable::VariableCollection();
+    auto env_var = variables.add_variable(variable::Variable(u8"ENV_VAR", u8"Environment variable description", true));
+    
+    // Create the application and manual
+    auto app = application::Application(std::move(summary), std::move(options), std::move(variables));
+    auto manual = manual::Manual(app);
+    
+    // Parse command line arguments
+    auto result = parser::Parser::from_system(app);
+    if (result.has_value()) {
+        auto parser = std::move(result.value());
+        
+        // Get values using validators
+        using IntValidator = validator::IntegralValidator<int>;
+        using FloatValidator = validator::FloatingPointValidator<float>;
+        using StringValidator = validator::StringValidator;
+        
+        // Check and get integer option
+        if (auto int_val = parser.get_value_option<IntValidator>(int_opt); int_val.has_value()) {
+            std::cout << "Integer value: " << int_val.value() << std::endl;
+        }
+        
+        // Check and get float option
+        if (auto float_val = parser.get_value_option<FloatValidator>(float_opt); float_val.has_value()) {
+            std::cout << "Float value: " << float_val.value() << std::endl;
+        }
+        
+        // Check and get string option
+        if (auto str_val = parser.get_value_option<StringValidator>(string_opt); str_val.has_value()) {
+            std::cout << "String value: " << str_val.value() << std::endl;
+        }
+        
+        // Check flag option
+        if (auto flag_val = parser.get_flag_option(flag_opt); flag_val.has_value() && flag_val.value()) {
+            std::cout << "Verbose mode enabled" << std::endl;
+        }
+    } else {
+        // Print help if parsing failed
+        manual.print_help(std::cout);
+        return 1;
+    }
+    
+    return 0;
+}
+\endcode
+
+This code handles command lines like:
+\code{.sh}
+./myapp -i 123 -f 2.5 --string "hello world" -v
+\endcode
+
+\section clap__components Components
+
+\subsection clap__application Application Definition
+
+The [Application](\ref application::Application) class represents a complete command line application with its summary, options, and environment variables.
+It combines the application metadata, command line options, and environment variables into a single unit.
+
+\subsection clap__options Options
+
+[Option](\ref option::Option) is command line arguments that can accept values or act as flags. 
+They can have both short names (single character)
+and long names (full text). The [OptionCollection](\ref option::OptionCollection) manages a collection of options and ensures no duplicates.
+
+\subsection clap__variables Variables
+
+[Variable](\ref variable::Variable) represent environment variables that can be captured and validated. The [VariableCollection](\ref variable::VariableCollection)
+manages a collection of environment variables and ensures no duplicates.
+
+\subsection clap__parsing Parsing
+
+The [Parser](\ref parser::Parser) class handles command line argument parsing. It can be created from user-provided arguments
+or from system arguments (argc/argv). Values are retrieved using type-safe validators.
+
+\subsection clap__validation Validation
+
+Validators ensure type-safe validation of command line argument values.
+The module provides built-in validators for:
+
+\li Integral types ([IntegralValidator](\ref validator::IntegralValidator))
+\li Floating-point types ([FloatingPointValidator](\ref validator::FloatingPointValidator))
+\li String types ([StringValidator](\ref validator::StringValidator))
+
+For some of them, you also can specify value range via template arguments.
+
+\section clap__custom_validators Custom Validator
+
+Custom validators can be created by implementing the \c Validator concept. 
+A valid validator must satisfy the following requirements:
+
+\li Have a type alias called \c ReturnType indicating the return value type
+\li Have a member function called \c validate that receives <TT>const std::u8string_view&</TT> as its only argument 
+and returns validated \c ReturnType or \c std::nullopt if validation fails
+
+Here is an example of a custom validator that validates email addresses:
+
+\code{.cpp}
+#include <yycc/string/reinterpret.hpp>
+#include <regex>
+
+struct EmailValidator {
+    using ReturnType = std::u8string;
+    
+    std::optional<ReturnType> validate(const std::u8string_view& sv) const {
+        // Simple email validation using regex
+        static const std::regex email_regex(
+            R"([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})");
+        
+        auto email_str = yycc::string::reinterpret::as_ordinary_view(sv);
+        if (std::regex_match(email_str, email_regex)) {
+            return sv;
+        }
+        return std::nullopt;
+    }
+};
+\endcode
+
+To use the custom validator:
+
+\code{.cpp}
+// Add option to application
+auto email_opt = options.add_option(option::Option(std::nullopt, u8"email", u8"EMAIL", u8"Email address"));
+
+// Use custom validator
+if (auto email_val = parser.get_value_option<EmailValidator>(email_opt); email_val.has_value()) {
+    std::cout << yycc::patch::format(u8"Valid email: {}", email_val); << std::endl;
+}
+\endcode
+
+\section clap__limitations Limitations
+
+Due to the limitations of implementation,
+CLAP now only allow only zero or one associated value for single option.
+More than one assocciated value for single option is not supported.
+
+*/
+}

doc/src/carton/csconsole.dox

@@ -0,0 +1,74 @@
+namespace yycc::carton::csconsole {
+/**
+
+\page csconsole Universal IO Function
+
+This namespace provide universal console IO function which is more like C\# provided,
+because Windows is lacking in UTF8 console IO.
+
+\section csconsole__deprecation Deprecation Notes
+
+This namespace, or this module is deprecated.
+Its provided functions are too aggressive and can not cover all use scenarios.
+So it is suggested not to use this namespace.
+Programmers should handle Windows UTF8 issues on their own.
+
+\section csconsole__why Why?
+
+Windows console doesn't support UTF8 very well.
+The standard input output functions can not work properly with UTF8 on Windows.
+So we create this namespace and provide various console-related functions
+to patch Windows console and let it more like the console in other platforms.
+
+The function provided in this function can be called in any platforms.
+In Windows, the implementation will use Windows native function,
+and in other platform, the implementation will redirect request to standard C function like \c std::fputs and etc.
+So the programmer do not need to be worried about which function should they use,
+and don't need to use macro to use different IO function in different platforms.
+It is just enough that fully use the functions provided in this namespace.
+
+All IO functions this namespace provided are UTF8-based.
+It also means that input output string should always be UTF8 encoded.
+
+\section csconsole__input Input Functions
+
+Please note that EOL will automatically converted into LF on Windows platform, not CRLF.
+This action actually is removing all CR chars in result string.
+This behavior affect nothing in most cases but it still is possible break something in some special case.
+
+Due to implementation, if you decide to use this function,
+you should give up using any other function to read stdin stream,
+such as \c std::gets() and \c std::cin.
+Because this function may read chars which is more than needed.
+These extra chars will be stored in this function and can be used next calling.
+But these chars can not be visited by stdin again.
+This behavior may cause bug.
+So if you decide using this function, stick on it and do not change.
+
+Due to implementation, this function do not support hot switch of stdin.
+It means that stdin can be redirected before first calling of this function,
+but it should not be redirected during program running.
+The reason is the same one introduced above.
+
+\section csconsole__output Output Functions
+
+In current implementation, EOL will not be converted automatically to CRLF.
+This is different with other stream read functions provided in this namespace.
+
+Comparing with other stream read functions provided in this namespace,
+stream write function support hot switch of stdout and stderr.
+Because they do not have internal buffer storing something.
+
+In this namespace, there are various stream write function.
+There is a list telling you how to choose one from them for using:
+
+\li Functions with leading "e" (like eformat, ewrite) will write data into stderr,
+otherwise they will write data into stdout.
+\li Functions with embedded "format" (format, format_line, eformat, eformat_line) are output functions with format feature like \c std::fprintf(), 
+otherwise the functions with embedded "write" in the name (write, write_line, ewrite, ewrite_line) will only write plain string like \c std::fputs().
+\li Functions with trailing "line" (format_line, write_line, eformat_line, ewrite_line) will write extra EOL to break current line.
+This is commonly used, otherwise functions will only write the text provided by arguments,
+without adding something.
+
+*/
+}

doc/src/carton/fft.dox

@@ -0,0 +1,93 @@
+namespace yycc::carton::fft {
+/**
+
+\page fft Homemade FFT
+
+This namespace provides a fast Fourier transform (FFT) implementation for signal processing applications.
+It includes classes for performing FFT computations on complex and real-valued signals, along with
+window functions to reduce spectral leakage.
+
+\section fft__basic_usage Basic Usage
+
+To use the FFT functionality for general purposes, use the FriendlyFft class:
+
+\code
+#include "yycc/carton/fft.hpp"
+using namespace yycc::carton::fft;
+
+// Create FFT instance for 8-point transform
+FriendlyFft<size_t, float, 8u> fft;
+
+// Prepare input data (must be power of 2 in length)
+float time_scope[8] = {1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f};
+float freq_scope[4]; // Output is half the input size
+
+// Create window function to reduce spectral leakage
+Window<size_t, float, 8u> window(WindowType::HanningWindow);
+
+// Perform FFT transformation
+fft.easy_compute(time_scope, freq_scope, window);
+
+// freq_scope now contains frequency domain data
+\endcode
+
+\section fft__window_functions Window Functions
+
+The library provides window functions to reduce spectral leakage:
+
+\code
+// Create a Hanning window for 16-point data
+Window<size_t, float, 16u> hanning_window(WindowType::HanningWindow);
+
+// Apply window to your data
+float data[16];
+// ... initialize data ...
+hanning_window.apply_window(data);
+\endcode
+
+\section fft__direct_fft Direct FFT Computation
+
+For more control over the FFT computation, use the core Fft class:
+
+\code
+#include "yycc/carton/fft.hpp"
+
+// Create FFT instance for 16-point transform
+Fft<size_t, double, 16u> fft;
+
+// Prepare complex input data
+std::complex<double> data[16];
+// ... initialize complex data ...
+
+// Perform FFT transformation
+fft.compute(data);
+// data now contains transformed values
+\endcode
+
+\section fft__predefined_types Predefined Types
+
+The library provides commonly used FFT types for convenience:
+
+\code
+// Float precision FFTs
+Fft4F fft4f;    // 4-point float FFT
+Fft8F fft8f;    // 8-point float FFT
+Fft16F fft16f;  // 16-point float FFT
+Fft256F fft256f; // 256-point float FFT
+
+// Double precision FFTs
+Fft4 fft4;      // 4-point double FFT
+Fft8 fft8;      // 8-point double FFT
+Fft16 fft16;    // 16-point double FFT
+Fft256 fft256;  // 256-point double FFT
+\endcode
+
+\section fft__requirements Requirements
+
+- Template parameters must satisfy certain constraints:
+  - \c TIndex: The index type used by FFT which must be an unsigned integral type.
+  - \c TFloat: The float point type used by FFT.
+  - \c VN: The point of FFT which must be a power of 2 and >= 2.
+
+*/
+}

doc/src/carton/ironpad.dox

@@ -1,30 +1,30 @@
-namespace YYCC::ExceptionHelper {
+namespace yycc::carton::ironpad {
 /**
 
-\page exception_helper Unhandled Exception Handler
+\page ironpad Unhandled Exception Handler
 
-Most Linux users are familiar with core dump.
+Most Linux users are familiar with using core dump to find bugs.
-However core dump is a tough work on Windows especially most Windows users are naive for getting core dump.
+However finding bugs is a tough work on Windows especially most Windows users are naive for getting core dump.
-So it is essential to make an easy-to-visit core dump Feature for Windows program.
+So it is essential to make an easy-to-visit core dump feature for Windows program.
-YYCC provides this feature in YYCC::ExceptionHelper.
+This is the reason why I create this module, yycc::carton::ironpad.
 
 You may know Google also has a similar and universal project called Crashpad used by Google Chrome.
 That's right. But it is too heavy.
 I just want to implement a tiny but worked core dump feature on Windows.
 
 This module is Windows specific.
-It will be invisible on other platforms.
+It still be available on other operating systems but all of its functions are do nothing.
 
-\section exception_helper__usage Usage
+\section ironpad__usage Usage
 
-\subsection exception_helper__usage__code Register Code
+\subsection ironpad__usage__code Register Code
 
-In most scenarios, programmer only need call #Register when program started or module loaded.
+In most scenarios, programmer only need call #startup when program started or module loaded.
-And call #Unregister when program exited or module unloaded.
+And call #shutdown when program exited or module unloaded.
 All details are hidden by these 2 feature.
 Programmer do not need worried about the implementation of unhandled exception handler.
 
-Optionally, you can provide a function pointer during calling #Register as a callback.
+Optionally, you can provide a function pointer during calling #startup as a callback.
 The prototype of this function pointer is #ExceptionCallback.
 This callback will be called if any unhandled exception happened.
 It provides 2 pathes to log file and core dump file respectively.
@@ -35,21 +35,21 @@ However, please note the pathes provided by callback may be empty.
 In this case, it means that handler fail to create corresponding log files.
 Also, if you trying to register unhandled exception handler on the same process in different module with different callback,
 only the callback provided in first success registering will be called when unhandled exception happened,
-due to \ref exception_helper__notes__singleton design.
+due to \ref ironpad__notes__singleton design.
 
-\subsection exception_helper__usage__location Location
+\subsection ironpad__usage__location Location
 
 When unhandled exception occurs, 
 unhandled exception handler will try to record error log and core dump in following path:
 
-\li Error Log: <TT>\%LOCALAPPDATA\%\\CrashDumps\\<I>program.exe</I>.<I>pid</I>.log</TT>
+\li Error Log: <TT>\%LOCALAPPDATA\%\\IronPad\\<I>program.exe</I>.<I>pid</I>.log</TT>
-\li Core Dump: <TT>\%LOCALAPPDATA\%\\CrashDumps\\<I>program.exe</I>.<I>pid</I>.dmp</TT>
+\li Core Dump: <TT>\%LOCALAPPDATA\%\\IronPad\\<I>program.exe</I>.<I>pid</I>.dmp</TT>
 
 The italic characters <I>program.exe</I> and <I>pid</I> will be replaced by program name and process ID respectively at runtime.
-Directory <TT>\%LOCALAPPDATA\%\\CrashDumps</TT> also is Windows used crash dump directory.
+Directory <TT>\%LOCALAPPDATA\%\\IronPad</TT> is the dedicated directory for this module.
-So you may see some other core dumps done by Windows in it.
+So you may see the generated logs and dumps in it.
 
-\subsection exception_helper__usage__last_remedy Last Remedy
+\subsection ironpad__usage__last_remedy Last Remedy
 
 If unhandled exception handler occurs error, these stuff may not be generated correctly.
 The end user may not find them and send them to you.
@@ -65,40 +65,40 @@ Also please note the last remedy may still have a little bit possibility to occu
 especially the error occurs in back trace function.
 There is no guaranteen that unhandled exception handler must generate error log and core dump.
 
-\section exception_helper__notes Notes
+\section ironpad__notes Notes
 
-\subsection exception_helper__notes__thread_safe Thread Safe
+\subsection ironpad__notes__thread_safe Thread Safe
 
-All exposed functions in YYCC::ExceptionHelper are thread safe.
+All exposed functions in this namespace are thread safe.
-The implementation uses \c std:mutex to ensure this.
+The implementation uses \c std::mutex to ensure this.
 
-\subsection exception_helper__notes__singleton Singleton Handler
+\subsection ironpad__notes__singleton Singleton Handler
 
-YYCC::ExceptionHelper also have a mechanism that make sure the same unhandled exception handler implementation only appear once in the same process.
+This namespace also have a mechanism that make sure the same unhandled exception handler implementation only appear once in the same process.
 For example, you have an executable program A.exe, and 2 dynamic libraries B.dll and C.dll.
 A.exe and B.dll use YYCC unhandled exception handler feature but C.dll not.
 A.exe will load B.dll and C.dll at runtime.
-Although both A.exe and B.dll call #Register,
+Although both A.exe and B.dll call #startup,
 when unhandled exception occurs, there is only one error report output, 
 which may be generated by A.exe or B.dll accoridng to their order of loading.
 
 The core purpose of this is making sure the program will not output too many error report for the same unhandled exception,
-no matter how many modules calling #Register are loaded.
+no matter how many modules calling #startup are loaded.
 Only one error report is enough.
 
 More precisely, we use \c CreateMutexW to create an unique mutex in Windows global scope,
-to make sure #Register only run once in the same process.
+to make sure #startup only run once in the same process.
 It is very like the implementation of singleton application.
 
-\subsection exception_helper__notes__recursive_calling Recursive Calling
+\subsection ironpad__notes__recursive_calling Recursive Calling
 
 The implementation of unhandled exception handler may also will throw exception.
 This will cause infinite recursive calling.
-YYCC::ExceptionHelper has internal mechanism to prevent this bad case.
+This namespace has internal mechanism to prevent this bad case.
 If this really happened, the handler will quit silent and will not cause any issue.
 Programmer don't need to worry about this.
 
-\subsection exception_helper__notes__user_callback The Timing of User Callback
+\subsection ironpad__notes__user_callback The Timing of User Callback
 
 The timing of calling user callback is the tail of unhandled exception handler.
 It means that all log and coredump have been written if possible before calling callback.

doc/src/carton/lexer61.dox

@@ -0,0 +1,102 @@
+namespace yycc::carton::lexer61 {
+/**
+
+\page lexer61 Homemade Command Line Lexer
+
+This namespace provides a lexer for parsing command-line arguments, supporting various quoting mechanisms,
+escape sequences, and Unicode characters. It follows the standard shell parsing rules for handling
+arguments containing spaces and special characters.
+
+\section lexer61__basic_usage Basic Usage
+
+To parse command line arguments, create a Lexer61 instance and call the Lexer61::lex() method:
+
+\code
+#include "yycc/carton/lexer61.hpp"
+using namespace yycc::carton::lexer61;
+
+Lexer61 lexer;
+auto result = lexer.lex(u8"program arg1 arg2 arg3");
+
+if (result.has_value()) {
+    auto args = std::move(result.value());
+    // args contains: [u8"program", u8"arg1", u8"arg2", u8"arg3"]
+    for (const auto& arg : args) {
+        std::wcout << reinterpret_cast<const wchar_t*>(arg.c_str()) << std::endl;
+    }
+}
+\endcode
+
+\section lexer61__quoting_support Quoting Support
+
+The lexer supports both single and double quotes for grouping arguments with spaces:
+
+\code
+Lexer61 lexer;
+
+// Double quotes
+auto result1 = lexer.lex(u8R"(program "argument with spaces" end)");
+// Result: [u8"program", u8"argument with spaces", u8"end"]
+
+// Single quotes
+auto result2 = lexer.lex(u8"program 'another argument' end");
+// Result: [u8"program", u8"another argument", u8"end"]
+
+// Mixed quotes
+auto result3 = lexer.lex(u8R"(program "double quoted 'single inside'" 'single quoted "double inside"')");
+// Result: [u8"program", u8"double quoted 'single inside'", u8"single quoted \"double inside\""]
+\endcode
+
+\section lexer61__escape_sequences Escape Sequences
+
+The lexer supports escape sequences for including special characters:
+
+\code
+Lexer61 lexer;
+auto result = lexer.lex(u8R"(program escaped\ space "quoted with \" quote" 'single with \' quote')");
+
+// Result: [u8"program", u8"escaped space", u8"quoted with \" quote", u8"single with \' quote"]
+\endcode
+
+\section lexer61__unicode_support Unicode Support
+
+The lexer fully supports Unicode characters in command line arguments:
+
+\code
+Lexer61 lexer;
+auto result = lexer.lex(u8"程序 中文 参数");
+// Result: [u8"程序", u8"中文", u8"参数"]
+
+// With quotes
+auto result2 = lexer.lex(u8R"(程序 "中文 参数" '另一个"引号"参数')");
+// Result: [u8"程序", u8"中文 参数", u8"另一个\"引号\"参数"]
+\endcode
+
+\section lexer61__empty_arguments Empty Arguments
+
+Empty arguments can be represented with empty quotes:
+
+\code
+Lexer61 lexer;
+auto result = lexer.lex(u8R"(program "" '')");
+
+// Result: [u8"program", u8"", u8""]
+\endcode
+
+\section lexer61__error_handling Error Handling
+
+The lexer uses \c std::expected for error handling:
+
+\code
+Lexer61 lexer;
+auto result = lexer.lex(u8R"(program "unclosed quote)");
+
+if (!result.has_value()) {
+    // Handle error - in this case, unclosed quote
+    std::cerr << "Error: unclosed quote" << std::endl;
+    std::abort();
+}
+\endcode
+
+*/
+}

doc/src/carton/pycodec.dox

@@ -0,0 +1,202 @@
+namespace yycc::carton::pycodec {
+/**
+\page pycodec Unified Codec (Python-like Codec)
+
+\section pycodec__overview Overview
+
+The unified encoding conversion module provides a consistent interface for character encoding conversion across different platforms. 
+It automatically selects the appropriate backend implementation based on the platform and available features.
+
+\section pycodec__classes Available Classes
+
+\subsection pycodec__classes__char Character to/from UTF-8 Conversion
+
+Convert between named encodings and UTF-8 using a unified interface:
+
+\code
+#include <yycc/carton/pycodec.hpp>
+
+// Example: Converting from a named encoding to UTF-8
+CharToUtf8 converter("GBK");  // or "ISO-8859-1", "SHIFT-JIS", etc.
+
+std::string gbk_text = "你好，世界！";
+auto result = converter.to_utf8(gbk_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting from UTF-8 to a named encoding
+Utf8ToChar converter("GBK");
+
+std::u8string utf8_text = u8"Hello, 世界!";
+auto result = converter.to_char(utf8_text);
+if (result.has_value()) {
+    std::string gbk_text = result.value();
+    // Use gbk_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\subsection pycodec__classes__wchar Wide Character to/from UTF-8 Conversion
+
+Convert between wide character strings and UTF-8:
+
+\code
+#include <yycc/carton/pycodec.hpp>
+
+// Example: Converting wide character to UTF-8
+WcharToUtf8 converter;
+
+std::wstring wide_text = L"Hello, 世界!";
+auto result = converter.to_utf8(wide_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-8 to wide character
+Utf8ToWchar converter;
+
+std::u8string utf8_text = u8"Hello, 世界!";
+auto result = converter.to_wchar(utf8_text);
+if (result.has_value()) {
+    std::wstring wide_text = result.value();
+    // Use wide_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\subsection pycodec__classes__utf16_utf32 UTF-8 to/from UTF-16/UTF-32 Conversion
+
+Convert between UTF encodings:
+
+\code
+#include <yycc/carton/pycodec.hpp>
+
+// Example: Converting UTF-8 to UTF-16
+Utf8ToUtf16 converter;
+
+std::u8string utf8_text = u8"Hello, 世界!";
+auto result = converter.to_utf16(utf8_text);
+if (result.has_value()) {
+    std::u16string utf16_text = result.value();
+    // Use utf16_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-16 to UTF-8
+Utf16ToUtf8 converter;
+
+std::u16string utf16_text = u"Hello, 世界!";
+auto result = converter.to_utf8(utf16_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-8 to UTF-32
+Utf8ToUtf32 converter;
+
+std::u8string utf8_text = u8"Hello, 世界! 🌍";
+auto result = converter.to_utf32(utf8_text);
+if (result.has_value()) {
+    std::u32string utf32_text = result.value();
+    // Use utf32_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-32 to UTF-8
+Utf32ToUtf8 converter;
+
+std::u32string utf32_text = U"Hello, 世界! 🌍";
+auto result = converter.to_utf8(utf32_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\section pycodec__utility Utility Functions
+
+\subsection pycodec__utility__validation Encoding Name Validation
+
+Check if an encoding name is valid in the current environment:
+
+\code
+#include <yycc/carton/pycodec.hpp>
+
+// Example: Validating an encoding name
+bool is_valid = is_valid_encoding_name(u8"UTF-8");
+if (is_valid) {
+    std::cout << "UTF-8 is a valid encoding name\n";
+} else {
+    std::cout << "UTF-8 is not supported\n";
+}
+
+// Test another encoding
+is_valid = is_valid_encoding_name(u8"GBK");
+\endcode
+
+\section pycodec__error_handling Error Handling
+
+All functions in this module return a result containing either 
+a ConvError struct represents conversion errors, or the final converted string.
+
+\code
+#include <yycc/carton/pycodec.hpp>
+
+CharToUtf8 converter("INVALID_ENCODING_NAME");
+std::string text = "Hello";
+
+auto result = converter.to_utf8(text);
+
+if (result.has_value()) {
+    std::u8string converted = result.value();
+    // Process successfully converted string
+} else {
+    // Handle conversion failure
+    std::cout << "Conversion failed\n";
+}
+\endcode
+
+\section pycodec__backend_specifics Platform-Specific Backends
+
+For detailed information about the specific platform backends, see:
+
+\li \ref encoding__windows : Windows-specific implementation using Win32 APIs
+\li \ref encoding__iconv : Iconv-based implementation for POSIX-like systems
+
+\section pycodec__notes Notes
+
+For all supported encoding names and their aliases,
+please browse code written in <TT>script/pycodec</TT> located in our source code.
+
+Please also note that not all encoding name has implementation for all platforms.
+Some uncommon encoding names are not supported on some backend due to the limitations of the corresponding baskend.
+These also can be found in that directory introduced above.
+
+*/
+}

doc/src/carton/tabulate.dox

@@ -0,0 +1,107 @@
+namespace yycc::carton::tabulate {
+/**
+
+\page tabulate Tabulate Utilities
+
+This namespace provides utilities for creating formatted tables in console output.
+It supports Unicode text, automatic column width calculation, customizable headers,
+and flexible display options.
+
+\section tabulate__basic_usage Basic Usage
+
+To create a simple table with headers and data rows:
+
+\code
+#include "yycc/carton/tabulate.hpp"
+using namespace yycc::carton::tabulate;
+
+// Create a table with 3 columns
+Tabulate table(3);
+
+// Set the header
+table.set_header({u8"Name", u8"Age", u8"City"});
+
+// Add data rows
+table.add_row({u8"Alice", u8"30", u8"New York"});
+table.add_row({u8"Bob", u8"25", u8"Los Angeles"});
+table.add_row({u8"Charlie", u8"35", u8"Chicago"});
+
+// Print the table
+table.print();
+\endcode
+
+This will output:
+\verbatim
+Name    Age City      
+-----   --- --------- 
+Alice   30  New York  
+Bob     25  Los Angeles
+Charlie 35  Chicago   
+\endverbatim
+
+\section tabulate__customization Customization Options
+
+You can customize various aspects of the table:
+
+\code
+Tabulate table(3);
+
+// Set a custom separator bar
+table.set_bar(u8"===");
+
+// Add a prefix (useful for indentation)
+table.set_prefix(u8"> ");
+
+// Control header and bar visibility
+table.show_header(false);  // Hide header
+table.show_bar(true);      // Show separator bar
+
+// Set header
+table.set_header({u8"Col1", u8"Col2", u8"Col3"});
+
+// Add data
+table.add_row({u8"data1", u8"data2", u8"data3"});
+
+table.print();
+\endcode
+
+\section tabulate__unicode_support Unicode Support
+
+The library fully supports Unicode text in tables:
+
+\code
+Tabulate table(3);
+
+// Set Unicode header
+table.set_header({u8"姓名", u8"年龄", u8"城市"});
+
+// Add Unicode data
+table.add_row({u8"张三", u8"30", u8"北京"});
+table.add_row({u8"李四", u8"25", u8"上海"});
+
+table.print();
+\endcode
+
+\section tabulate__stream_output Stream Output
+
+You can print to any output stream, not just stdout:
+
+\code
+#include <fstream>
+
+Tabulate table(2);
+table.set_header({u8"Key", u8"Value"});
+table.add_row({u8"temp", u8"25C"});
+
+// Print to file
+std::ofstream file("table.txt");
+table.print(file);
+
+// Or print to stringstream
+std::stringstream ss;
+table.print(ss);
+std::string table_str = ss.str();
+\endcode
+
+*/
+}

doc/src/carton/termcolor.dox

@@ -0,0 +1,121 @@
+namespace yycc::carton::termcolor {
+/**
+
+\page termcolor Terminal Color Utilities
+
+This namespace provides functions to generate ANSI escape sequence for terminal font color and style.
+It also provides functions to add color and style for given string with ANSI Escape Sequence.
+
+Supported color is limited in 16 colors,
+because these color is implemented by ASCII Escape Code: https://en.wikipedia.org/wiki/ANSI_escape_code .
+So if your terminal do not support this, such as default Windows terminal, or teletypewriter,
+you will see some unrecognised characters surrounding with your output.
+That's ASCII Escape Code.
+
+This namespace is basically the imitation of the Python package with same name.
+
+\section termcolor__basic_colors Basic Colors
+
+To use basic foreground and background colors:
+
+\code
+#include "yycc/carton/termcolor.hpp"
+using namespace yycc::carton::termcolor;
+
+// Print red text
+std::cout << colored(u8"Error message", Color::Red) << std::endl;
+
+// Print blue text with yellow background
+cprint(u8"Info message", Color::Blue, Color::Yellow);
+\endcode
+
+\section termcolor__light_colors Light Colors
+
+The namespace provides both standard and light versions of colors:
+
+\code
+// Standard green
+std::cout << colored(u8"Success", Color::Green) << std::endl;
+
+// Light green (brighter variant)
+std::cout << colored(u8"Notice", Color::LightGreen) << std::endl;
+\endcode
+
+\section termcolor__text_styles Text Styles
+
+Multiple text styles can be combined using bitwise operations:
+
+\code
+// Bold text
+std::cout << colored(u8"Important", Color::Red, Color::Default, Attribute::Bold) << std::endl;
+
+// Underlined text
+std::cout << colored(u8"Underlined", Color::Blue, Color::Default, Attribute::Underline) << std::endl;
+
+// Combined styles
+auto combined_style = yycc::cenum::merge(Attribute::Bold, Attribute::Italic);
+cprint(u8"Bold and italic", Color::Magenta, Color::Default, combined_style);
+\endcode
+
+\section termcolor__convenience_functions Convenience Functions
+
+Several convenience functions are available for direct printing:
+
+\code
+// Print to stdout with color
+cprint(u8"Hello World", Color::Green);
+
+// Print to stderr with color and style
+ceprint(u8"Warning", Color::Yellow, Color::Default, Attribute::Bold);
+
+// Print with line break
+cprintln(u8"Success", Color::LightGreen);
+
+// Print to stderr with line break
+ceprintln(u8"Critical Error", Color::LightRed, Color::Default, Attribute::Blink);
+\endcode
+
+\section termcolor__color_enums Available Colors
+
+Available foreground and background colors include:
+
+\li Color::Black
+\li Color::Red
+\li Color::Green
+\li Color::Yellow
+\li Color::Blue
+\li Color::Magenta
+\li Color::Cyan
+\li Color::White
+\li Color::LightBlack
+\li Color::LightRed
+\li Color::LightGreen
+\li Color::LightYellow
+\li Color::LightBlue
+\li Color::LightMagenta
+\li Color::LightCyan
+\li Color::LightWhite
+\li Color::Default
+
+\section termcolor__style_enums Available Styles
+
+Available text styles include:
+
+\li Attribute::Bold
+\li Attribute::Dark
+\li Attribute::Italic
+\li Attribute::Underline
+\li Attribute::Blink
+\li Attribute::Reverse
+\li Attribute::Concealed
+\li Attribute::Default
+
+\section termcolor__old_macros Where is Old Macros
+
+If you have used YYCC 1.x version, you may know that these features are also presented but in a bunch of macros style.
+These macros is removed since YYCC 2.0.
+Since YYCC 2.0, we suggest you to use these new provided functions instead,
+because they are more robust and correspond with our new style of coding by \c std::format and etc.
+
+*/
+}

doc/src/carton/wcwidth.dox

@@ -0,0 +1,103 @@
+namespace yycc::carton::wcwidth {
+/**
+
+\page wcwidth Cross-platform Wcwidth
+
+This namespace provides cross-platform implementations of character width calculation functions,
+similar to the Linux-specific \c wcswidth function. It supports Unicode text and ANSI escape sequences,
+making it suitable for calculating display widths of text in terminals across different platforms.
+
+\section wcwidth__basic_usage Basic Usage
+
+To calculate the display width of a string in a terminal:
+
+\code
+#include <yycc/carton/wcwidth.hpp>
+using namespace yycc::carton::wcwidth;
+
+// Calculate width of ASCII text
+size_t width1 = wcwidth(U'a');  // Returns 1
+auto width2 = wcswidth(u8"Hello");  // Returns 5
+
+// Calculate width of Unicode text
+auto width3 = wcswidth(u8"你好世界");  // Returns 8 (Chinese chars typically take 2 spaces each)
+auto width4 = wcswidth(u8"ありがとう");  // Returns 10 (Japanese katakana)
+\endcode
+
+\section wcwidth__ansi_support ANSI Escape Sequence Support
+
+The library can handle ANSI escape sequences (like color codes) in text
+which is not supported by Linux \c wcswidth.
+
+\code
+#include "yycc/carton/termcolor.hpp"
+using namespace yycc::carton::termcolor;
+
+// Calculate width of colored text
+auto colored_text = colored(u8"Hello World", Color::Red);
+auto width = wcswidth(colored_text);
+// Returns the width of "Hello World" (ignoring the ANSI escape sequences)
+\endcode
+
+\section wcwidth__error_handling Error Handling
+
+The functions use \c std::expected for error handling:
+
+\code
+#include "yycc/carton/wcwidth.hpp"
+
+// Safe way to handle potential errors
+auto result = wcswidth(u8"\033?");  // Invalid ANSI sequence
+
+if (result.has_value()) {
+    size_t width = result.value();
+    std::cout << "Width: " << width << std::endl;
+} else {
+    std::cout << "Invalid string" << std::endl;
+}
+\endcode
+
+\section wcwidth__character_types Supported Character Types
+
+The library provides two main functions:
+
+- wcwidth(): Calculate width of a single character.
+- wcswidth(): Calculate width of a string.
+
+\code
+// Using wcwidth for single characters
+size_t char_width = wcwidth(U'A');        // Returns 1
+size_t emoji_width = wcwidth(U'😀');      // Returns width of emoji
+
+// Using wcswidth for strings
+auto str_width1 = wcswidth(u8"Hello");          // Returns 5
+auto str_width2 = wcswidth(U"Unicode String");  // Returns string length in display width
+\endcode
+
+\section wcwidth__platform_differences Platform Considerations
+
+This library addresses platform differences in wide character handling:
+
+\li On Linux, \c whar_t is 4 bytes and can represent any Unicode character
+\li On Windows, \c whar_t is 2 bytes and may require surrogate pairs for some characters
+
+So this library uses \c char32_t internally to ensure consistent behavior across platforms,
+and expose functions with \c char32_t and \c char8_t string container respectively for user.
+
+\section wcwidth__unicode_support Unicode and East Asian Widths
+
+The library properly handles East Asian character widths:
+
+\code
+// Chinese characters typically occupy 2 terminal spaces
+auto chinese_width = wcswidth(u8"中文");  // Returns 4 (2 chars × 2 spaces each)
+
+// Japanese characters
+auto kana_width = wcswidth(u8"ありがとう");  // Returns 10 (5 kana × 2 spaces each)
+
+// Mixed text
+auto mixed_width = wcswidth(u8"Hello 世界");  // Returns 8 (5 ASCII + 1 space + 2 Chinese chars × 2 spaces)
+\endcode
+
+*/
+}

doc/src/cenum.dox

@@ -0,0 +1,37 @@
+namespace yycc::cenum {
+/**
+
+\page cenum Scoped Enum Helper
+
+\section cenum__intro Intro
+
+C++ introduce a new enum called scoped enum.
+It is better than legacy C enum because it will not leak name into namespace where it locate,
+and also can specify an underlying type to it to make sure it is stored as specified size.
+However, the shortcoming of it is that it lack bitwise operator comparing with legacy C enum.
+Programmer must implement them for scoped enum one by one but it is a hardship and inconvenient.
+This is the reason why I invent this class.
+And this is the reason why I call this module "cenum"
+because it gives scoped enum type with the same abilities of legacy C enum.
+
+\section cenum__Usage Usage
+
+In this namespace, we provide all bitwise functions related to scoped enum type which may be used.
+See yycc::cenum for more detail (It is more clear to read function annotation than I introduce in there repeatedly).
+
+\section cenum__why Why not Operator Overload Way
+
+I have try it (and you even can see the relic of it in source code).
+But it need a extra statement written in following to include it, otherwise compiler can not see it.
+
+\code
+using namespace yycc::cenum;
+\endcode
+
+The last and most important reason why I do not use this method is that
+this overload strategy may be applied to some type which should not be applied by accient, such as non-scoped enum type.
+So I gave up this solution.
+It is much better that order user explicitly specify when to use them.
+
+*/
+}

doc/src/com_helper.dox

@@ -1,35 +0,0 @@
-namespace YYCC::COMHelper {
-/**
-
-\page com_helper COM Helper
-
-This namespace is Windows specific.
-It will be invisible on other platforms.
-
-This namespace is used by internal functions as intended.
-They should not be used outside of this library.
-But if you compel to use them, it is also okey.
-
-\section com_helper__memory_safe_ptr Memory Safe Pointer Types
-
-This namespace also provided various memory-safe types for interacting with COM functions.
-Although Microsoft also has similar smart pointer called \c CComPtr.
-But this library is eager to hide all Microsoft-related functions calling.
-Using \c CComPtr is not corresponding with the philosophy of this library.
-So these standard library based smart pointer types were created.
-
-\section com_helper__com_guard COM Guard
-
-This namespace contain a COM Guard which make sure COM was initialized in current module when loading current module.
-It is essential because all calling to COM functions should be under the premise that COM has been initialized.
-This guard also will uninitialize COM when unloading this module.
-
-There is only an exposed function called #IsInitialized for user calling.
-This function will check whether COM environment is initialized.
-If you want YYCC automatically initialize COM environment for you,
-you must call this function in your program at least one time.
-Otherwise COM Guard code may be unavailable,
-because compiler may think they are not essential code and drop them.
-
-*/
-}

doc/src/config_manager.dox

@@ -1,97 +0,0 @@
-namespace YYCC::ConfigManager {
-/**
-
-\page config_manager Universal Config Manager
-
-YYCC::ConfigManager give programmer an universal way to manage its program settings.
-There is an example about how to use universal config manager.
-In following content, we will describe it in detail.
-
-\code
-class TestConfigManager {
-public:
-    enum class TestEnum : int8_t {
-        Test1, Test2, Test3
-    };
-
-    TestConfigManager() :
-        m_IntSetting(YYCC_U8("int-setting"), INT32_C(0)),
-        m_StringSetting(YYCC_U8("string-setting"), YYCC_U8("")),
-        m_FloatSetting(YYCC_U8("float-setting"), 0.0f, YYCC::Constraints::GetNumberRangeConstraint<float>(-1.0f, 1.0f)),
-        m_EnumSetting(YYCC_U8("enum-setting"), TestEnum::Test1),
-        m_CoreManager(YYCC_U8("test.cfg"), UINT64_C(0), {
-            &m_IntSetting, &m_StringSetting, &m_FloatSetting, &m_EnumSetting
-        })
-    {}
-    ~TestConfigManager() {}
-
-    YYCC::ConfigManager::NumberSetting<int32_t> m_IntSetting;
-    YYCC::ConfigManager::StringSetting m_StringSetting;
-    YYCC::ConfigManager::NumberSetting<float> m_FloatSetting;
-    YYCC::ConfigManager::NumberSetting<TestEnum> m_EnumSetting;
-
-    YYCC::ConfigManager::CoreManager m_CoreManager;
-};
-
-// Initialize config manager
-TestConfigManager test;
-// Load settings.
-test.m_CoreManager.Load()
-// Get string setting value.
-auto val = test.m_StringSetting.Get();
-\endcode
-
-\section config_manager__setting Setting
-
-Setting can be seen as the leaf of the config tree.
-Each setting describe a single configuration entry.
-
-\subsection config_manager__setting__presets Setting Presets
-
-We currently provide 2 setting preset classes which you can directly use.
-
-\li NumberSetting: The setting storing a number inside.
-It is a template class. Support all arithmetic and enum types (integral, floating point, bool, enum).
-\li StringSetting: The setting storing a string inside.
-
-When constructing these settings,
-you need to provide its unique name which will be used when saving to file or reading from file.
-Also you need to provide a default value for it.
-It will be used when fail to read file or initializing itself.
-
-Optionally, you also can provide a constraint to setting.
-Constraint is the struct instructing library to limit value in specified range.
-It usually is used for making sure the setting stored value is valid.
-See \ref constraints chapters to know how we provide constraints.
-
-\subsection config_manager__setting__custom Custom Setting
-
-In most cases, the combination use of setting presets and constraints is enough.
-However, if you still are urge to create your personal setting,
-please inherit AbstractSetting and implement essential class functions.
-For the class functions you need to implement,
-please refer to our setting presets, NumberSetting and StringSetting.
-
-\section config_manager__core_manager Core Manager
-
-CoreManager manage a collection of settings.
-And have responsibility to reading and writing config file.
-
-We highly suggest that you create a personal config manager class like example does.
-Then put essential settings and core manager inside it.
-Please note you must place core manager after all settings.
-Because the order of C++ initializing its class member is the order you declared them.
-The constructor of core manager need the pointer to all it managed settings,
-so it must be initialized after initializing all settings.
-
-When initializing core manager, you need assign config file path first.
-Then you need specify a version number.
-Version number will be used when reading config file.
-If the version of config file is higher than your given number,
-core manager will assume you are trying to read a config file created by a higher version program.
-Core manager will reject reading and use default value for all settings.
-Otherwise, core manager will try to read config file and do proper migration if possible.
-The last argument is an initializer list which contain the \b pointer to all settings this manager managed.
-
-*/
-}

doc/src/console_helper.dox

@@ -1,181 +0,0 @@
-namespace YYCC::ConsoleHelper {
-/**
-
-\page console_helper Console Helper
-
-This helper provide console related stuff.
-This helper includes 2 parts.
-First part is console color.
-It was constituted by a bunch of macros.
-The second part is universal console IO function because Windows is lacking in UTF8 console IO.
-All of these parts will be introduced in following content.
-
-\section console_helper__color Console Color
-
-YYCC::ConsoleHelper provide a bunch of macros which can allow you output colorful text in terminal.
-Supported color is limited in 16 colors,
-because these color is implemented by ASCII Escape Code: https://en.wikipedia.org/wiki/ANSI_escape_code .
-So if your terminal do not support this, such as default Windows terminal, or teletypewriter,
-you will see some unrecognised characters surrounding with your output.
-That's ASCII Escape Code.
-
-\subsection console_helper__color__enable_win_color Enable Color in Windows Console
-
-As we introduced in above,
-you may know Windows console does not support ASCII Escape Code color in default.
-However #EnableColorfulConsole can fix this issue.
-
-#EnableColorfulConsole will forcely enable ASCII Escape Code support in Windows console if possible.
-Thus you can write colorful text in Windows console freely.
-We suggest you to call this function at the beginning of program.
-
-Considering most Linux console supports ASCII Escape Code very well,
-this function does nothing in non-Windows platform.
-So it is not essential that brack this function calling with Windows-only \c \#if.
-
-\subsection console_helper__color__common Common Usage
-
-For common scenarios, you can use macro like this:
-
-\code
-YYCC::ConsoleHelper::WriteLine(YYCC_U8(YYCC_COLOR_LIGHT_RED("Light Red Text")));
-YYCC::ConsoleHelper::WriteLine(YYCC_U8("I am " YYCC_COLOR_LIGHT_RED("Light Red")));
-\endcode
-
-In first line, it will make <TT>"Light Red Text"</TT> to be shown in light red color.
-And for second line, it will make <TT>"Light Red"</TT> to be shown in light red color,
-but <TT>"I am "</TT> will keep default console font color.
-
-You also may notice this macro is used with YYCC_U8 macro.
-Because #WriteLine only accept UTF8 argument.
-So please note if you use console color macro with YYCC_U8,
-please make YYCC_U8 always is located the outside.
-Otherwise, YYCC_U8 will fail to make the whole become UTF8 stirng as we introduced in \ref library_encoding.
-Because console color macro is implemented by string literal concatenation internally.
-
-YYCC_COLOR_LIGHT_RED is a member in YYCC_COLOR macro family.
-YYCC_COLOR macro family has 16 members for 16 different colors:
-
-\li YYCC_COLOR_BLACK
-\li YYCC_COLOR_RED
-\li YYCC_COLOR_GREEN
-\li YYCC_COLOR_YELLOW
-\li YYCC_COLOR_BLUE
-\li YYCC_COLOR_MAGENTA
-\li YYCC_COLOR_CYAN
-\li YYCC_COLOR_WHITE
-\li YYCC_COLOR_LIGHT_BLACK
-\li YYCC_COLOR_LIGHT_RED
-\li YYCC_COLOR_LIGHT_GREEN
-\li YYCC_COLOR_LIGHT_YELLOW
-\li YYCC_COLOR_LIGHT_BLUE
-\li YYCC_COLOR_LIGHT_MAGENTA
-\li YYCC_COLOR_LIGHT_CYAN
-\li YYCC_COLOR_LIGHT_WHITE
-
-\subsection console_helper__color__embedded Embedded Usgae
-
-In some cases, you want change console at some time point and reset it in another time point.
-You can use color macros like following example:
-
-\code
-YYCC::ConsoleHelper::WriteLine(YYCC_U8(YYCC_COLORHDR_LIGHT_BLUE));
-
-// Write as much as you liked
-YYCC::ConsoleHelper::WriteLine(YYCC_U8("some string"));
-YYCC::ConsoleHelper::WriteLine(YYCC_U8("another string"));
-
-YYCC::ConsoleHelper::WriteLine(YYCC_U8(YYCC_COLORTAIL));
-\endcode
-
-At first line, we output YYCC_COLORHDR_LIGHT_BLUE which is in YYCC_COLORHDR macro family.
-It is colorful text ASCII Escape Code head.
-It will make all following output become light blue color,
-until the last line we output YYCC_COLORTAIL to reset console color to original color.
-
-Same as YYCC_COLOR macro family, 
-YYCC_COLORHDR macro family also has 16 members for 16 different colors:
-
-\li YYCC_COLORHDR_BLACK
-\li YYCC_COLORHDR_RED
-\li YYCC_COLORHDR_GREEN
-\li YYCC_COLORHDR_YELLOW
-\li YYCC_COLORHDR_BLUE
-\li YYCC_COLORHDR_MAGENTA
-\li YYCC_COLORHDR_CYAN
-\li YYCC_COLORHDR_WHITE
-\li YYCC_COLORHDR_LIGHT_BLACK
-\li YYCC_COLORHDR_LIGHT_RED
-\li YYCC_COLORHDR_LIGHT_GREEN
-\li YYCC_COLORHDR_LIGHT_YELLOW
-\li YYCC_COLORHDR_LIGHT_BLUE
-\li YYCC_COLORHDR_LIGHT_MAGENTA
-\li YYCC_COLORHDR_LIGHT_CYAN
-\li YYCC_COLORHDR_LIGHT_WHITE
-
-However YYCC_COLORTAIL is YYCC_COLORTAIL.
-There is no other variant for different colors.
-Because all tail of colorful ASCII Escape Code is same.
-
-\section console_helper__universal_io Universal IO Function
-
-\subsection console_helper__universal_io__why Why?
-
-Windows console doesn't support UTF8 very well.
-The standard input output functions can not work properly with UTF8 on Windows.
-So we create this namespace and provide various console-related functions
-to patch Windows console and let it more like the console in other platforms.
-
-The function provided in this function can be called in any platforms.
-In Windows, the implementation will use Windows native function,
-and in other platform, the implementation will redirect request to standard C function like \c std::fputs and etc.
-So the programmer do not need to be worried about which function should they use,
-and don't need to use macro to use different IO function in different platforms.
-It is just enough that fully use the functions provided in this namespace.
-
-All IO functions this namespace provided are UTF8-based.
-It also means that input output string should always be UTF8 encoded.
-
-\subsection console_helper__universal_io__input Input Functions
-
-Please note that EOL will automatically converted into LF on Windows platform, not CRLF.
-This action actually is removing all CR chars in result string.
-This behavior affect nothing in most cases but it still is possible break something in some special case.
-
-Due to implementation, if you decide to use this function,
-you should give up using any other function to read stdin stream,
-such as \c std::gets() and \c std::cin.
-Because this function may read chars which is more than needed.
-These extra chars will be stored in this function and can be used next calling.
-But these chars can not be visited by stdin again.
-This behavior may cause bug.
-So if you decide using this function, stick on it and do not change.
-
-Due to implementation, this function do not support hot switch of stdin.
-It means that stdin can be redirected before first calling of this function,
-but it should not be redirected during program running.
-The reason is the same one introduced above.
-
-\subsection console_helper__universal_io__output Output Functions
-
-In current implementation, EOL will not be converted automatically to CRLF.
-This is different with other stream read functions provided in this namespace.
-
-Comparing with other stream read functions provided in this namespace,
-stream write function support hot switch of stdout and stderr.
-Because they do not have internal buffer storing something.
-
-In this namespace, there are various stream write function.
-There is a list telling you how to choose one from them for using:
-
-\li Functions with leading "Err" will write data into stderr,
-otherwise they will write data into stdout.
-\li Functions with embedded "Format" are output functions with format feature
-like \c std::fprintf(), otherwise the functions with embedded "Write" will
-only write plain string like \c std::fputs().
-\li Functions with trailing "Line" will write extra EOL to break current line.
-This is commonly used, otherwise functions will only write the text provided by arguments,
-without adding something.
-
-*/
-}

doc/src/constraints.dox

@@ -1,49 +0,0 @@
-namespace YYCC::Constraints {
-/**
-
-\page constraints Constraints
-
-YYCC::Constraints namespace provide Constraint struct declaration
-and various common constraint generator function.
-
-This namespace is specifically used by YYCC::ConfigManager and YYCC::ArgParser namespaces.
-See \ref config_manager chapter and \ref arg_parser chapter for how to utlize this namespace.
-
-\section constraints__prototype Prototype
-
-Constraint instruct library how check whether given value is in range,
-and how to clamp it if it is invalid.
-For example, you can use constraint to limit a number in given minimum maximum value,
-or limit a string in specific format by using regex and etc.
-
-Constraint is a template struct.
-The argument of template is the underlying data type which need to be checked.
-The struct with different template argument is not compatible.
-
-Currently, this struct only contain 1 function pointer,
-which is used for detecting whether given value is in range / valid.
-
-\subsection constraints__presets Constraint Presets
-
-YYCC::Constraints provides some constraint presets which are commonly used.
-All functions inside this namespace will return a Constraint instance,
-and you can directly use it.
-
-There is a list of all provided functions:
-
-\li GetMinMaxRangeConstraint(): Limit the number value in given minimum maximum value range (inclusive).
-\li GetEnumEnumerationConstraint(): Limit the enum value by given all possible value set.
-\li GetStringEnumerationConstraint(): Limit the string by given all possible value set.
-
-\subsection config_manager__constraint__custom Custom Constraint
-
-For creating your personal constraint,
-you need to create Constraint instance manually.
-You can browse all existing constraint preset functions code for know how to write it.
-
-The things you need to do is simple.
-First, you need decide the template argument of Constraint.
-Second, you need assign class member of Constraint by C++ lambda syntax.
-
-*/
-}

doc/src/encoding/iconv.dox

@@ -0,0 +1,166 @@
+namespace yycc::encoding::iconv {
+/**
+\page encoding__iconv Iconv-based Codec
+
+\section encoding__iconv__overview Overview
+
+The Iconv-based encoding conversion module provides encoding conversion functionality using the iconv library. 
+This module is available when you are in POSIX system, or enable iconv support manually when configuring the library.
+
+\section encoding__iconv__classes Available Classes
+
+\subsection encoding__iconv__classes__char Char to/from UTF-8 Conversion
+
+Convert between character encodings and UTF-8:
+
+\code
+#include <yycc/encoding/iconv.hpp>
+
+// Example: Creating a converter from Latin-1 to UTF-8
+CharToUtf8 converter("ISO-8859-1");
+
+std::string latin1_text = "Café résumé naïve";
+auto result = converter.to_utf8(latin1_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Creating a converter from UTF-8 to Latin-1
+Utf8ToChar converter("ISO-8859-1");
+
+std::u8string utf8_text = u8"Café résumé naïve";
+auto result = converter.to_char(utf8_text);
+if (result.has_value()) {
+    std::string latin1_text = result.value();
+    // Use latin1_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\subsection encoding__iconv__classes__wchar WChar to/from UTF-8 Conversion
+
+Convert between wide character and UTF-8:
+
+\code
+#include <yycc/encoding/iconv.hpp>
+
+// Example: Converting wide character to UTF-8
+WcharToUtf8 converter;
+
+std::wstring wide_text = L"Hello, 世界!";
+auto result = converter.to_utf8(wide_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-8 to wide character
+Utf8ToWchar converter;
+
+std::u8string utf8_text = u8"Hello, 世界!";
+auto result = converter.to_wchar(utf8_text);
+if (result.has_value()) {
+    std::wstring wide_text = result.value();
+    // Use wide_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\subsection encoding__iconv__classes__utf16_utf32 UTF-8 to/from UTF-16/UTF-32 Conversion
+
+Convert between UTF encodings:
+
+\code
+#include <yycc/encoding/iconv.hpp>
+
+// Example: Converting UTF-8 to UTF-16
+Utf8ToUtf16 converter;
+
+std::u8string utf8_text = u8"Hello, 世界!";
+auto result = converter.to_utf16(utf8_text);
+if (result.has_value()) {
+    std::u16string utf16_text = result.value();
+    // Use utf16_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-16 to UTF-8
+Utf16ToUtf8 converter;
+
+std::u16string utf16_text = u"Hello, 世界!";
+auto result = converter.to_utf8(utf16_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-8 to UTF-32
+Utf8ToUtf32 converter;
+
+std::u8string utf8_text = u8"Hello, 世界! 🌍";
+auto result = converter.to_utf32(utf8_text);
+if (result.has_value()) {
+    std::u32string utf32_text = result.value();
+    // Use utf32_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-32 to UTF-8
+Utf32ToUtf8 converter;
+
+std::u32string utf32_text = U"Hello, 世界! 🌍";
+auto result = converter.to_utf8(utf32_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\section encoding__iconv__error_handling Error Handling
+
+All functions in this module return a result containing either 
+a ConvError struct represents conversion errors, or the final converted string.
+
+\code
+#include <yycc/encoding/iconv.hpp>
+
+CharToUtf8 converter("INVALID_ENCODING");
+// Note: Constructor errors might be detected during conversion
+
+std::string text = "Hello";
+auto result = converter.to_utf8(text);
+
+if (result.has_value()) {
+    std::u8string converted = result.value();
+    // Process successfully converted string
+} else {
+    // Handle conversion failure
+    std::cout << "Conversion failed\n";
+}
+\endcode
+
+*/
+}

doc/src/encoding/stl.dox

@@ -0,0 +1,98 @@
+namespace yycc::encoding::stl {
+/**
+\page encoding__stl STL-based Codec
+
+\section encoding__stl__overview Overview
+
+The STL-based encoding conversion module provides cross-platform encoding conversion functionality using the standard library's codecvt facets.
+This module is designed to handle conversions between UTF-8, UTF-16, and UTF-32 encodings using the standard C++ locale facilities.
+
+\section encoding__stl__attentions Attentions
+
+The underlying implementation of this module is deprecated by C++ STL and may be removed in future versions of C++.
+So please use this module carefully or considering use our \ref pycodec module instead.
+
+\section encoding__stl__functions Available Functions
+
+\subsection encoding__stl__functions__utf16 UTF-8 to/from UTF-16 Conversion
+
+Convert between UTF-8 and UTF-16 encodings using standard library facilities:
+
+\code
+#include <yycc/encoding/stl.hpp>
+
+// Example: Converting UTF-8 to UTF-16
+std::u8string utf8_text = u8"Hello, 世界!";
+auto result = to_utf16(utf8_text);
+if (result.has_value()) {
+    std::u16string utf16_text = result.value();
+    // Use utf16_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-16 to UTF-8
+std::u16string utf16_text = u"Hello, 世界!";
+auto result = to_utf8(utf16_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\subsection encoding__stl__functions__utf32 UTF-8 to/from UTF-32 Conversion
+
+Convert between UTF-8 and UTF-32 encodings:
+
+\code
+#include <yycc/encoding/stl.hpp>
+
+// Example: Converting UTF-8 to UTF-32
+std::u8string utf8_text = u8"Hello, 世界! 🌍";
+auto result = to_utf32(utf8_text);
+if (result.has_value()) {
+    std::u32string utf32_text = result.value();
+    // Use utf32_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-32 to UTF-8
+std::u32string utf32_text = U"Hello, 世界! 🌍";
+auto result = to_utf8(utf32_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\section encoding__stl__error_handling Error Handling
+
+All functions in this module return a result containing either 
+a ConvError struct represents conversion errors, or the final converted string.
+
+\code
+#include <yycc/encoding/stl.hpp>
+
+std::u8string invalid_utf8 = "\xFF\xFE"; // Invalid UTF-8 sequence
+auto result = to_utf16(invalid_utf8);
+
+if (result.has_value()) {
+    std::u16string converted = result.value();
+    // Process successfully converted string
+} else {
+    // Handle conversion failure
+    std::cout << "Conversion failed\n";
+}
+\endcode
+
+*/
+}

doc/src/encoding/windows.dox

@@ -0,0 +1,191 @@
+namespace yycc::encoding::windows {
+/**
+\page encoding__windows Win32-based Codec
+
+\section encoding__windows__overview Overview
+
+The Windows-specific encoding conversion module provides encoding conversion functionality 
+using Windows API functions such as `WideCharToMultiByte` and `MultiByteToWideChar`. 
+This module is available only on Windows platforms and offers efficient conversion 
+between various character encodings including wide character, multi-byte, and UTF-8.
+
+\section encoding__windows__functions Available Functions
+
+\subsection encoding__windows__functions__wchar Wide Character to/from Multi-byte Conversion
+
+Convert between wide character strings and multi-byte strings using Windows code pages:
+
+\code
+#include <yycc/encoding/windows.hpp>
+
+// Example: Converting wide character string to multi-byte with specific code page
+std::wstring wide_text = L"Hello, 世界!";
+auto result = to_char(wide_text, CP_UTF8);  // Using UTF-8 code page
+if (result.has_value()) {
+    std::string multi_byte_text = result.value();
+    // Use multi_byte_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting multi-byte string to wide character with specific code page
+std::string multi_byte_text = "Hello, 世界!";
+auto result = to_wchar(multi_byte_text, CP_UTF8);
+if (result.has_value()) {
+    std::wstring wide_text = result.value();
+    // Use wide_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\subsection encoding__windows__functions__mbcs Multi-byte to/from Multi-byte Conversion
+
+Convert between different multi-byte encodings by using wide character as an intermediate:
+
+\code
+#include <yycc/encoding/windows.hpp>
+
+// Example: Converting between two different code pages
+std::string source_text = "Hello, world!";
+auto result = to_char(source_text, CP_ACP, CP_UTF8);  // ANSI to UTF-8
+if (result.has_value()) {
+    std::string utf8_text = result.value();
+    // Use converted UTF-8 text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\subsection encoding__windows__functions__utf8 UTF-8 Specific Conversions
+
+Specialized functions for UTF-8 conversion without requiring explicit code page specification:
+
+\code
+#include <yycc/encoding/windows.hpp>
+
+// Example: Converting wide character to UTF-8
+std::wstring wide_text = L"Hello, 世界!";
+auto result = to_utf8(wide_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-8 to wide character
+std::u8string utf8_text = u8"Hello, 世界!";
+auto result = to_wchar(utf8_text);
+if (result.has_value()) {
+    std::wstring wide_text = result.value();
+    // Use wide_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting multi-byte to UTF-8
+std::string multi_byte_text = "Hello, world!";
+auto result = to_utf8(multi_byte_text, CP_ACP);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-8 to multi-byte
+std::u8string utf8_text = u8"Hello, world!";
+auto result = to_char(utf8_text, CP_ACP);
+if (result.has_value()) {
+    std::string multi_byte_text = result.value();
+    // Use multi_byte_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\subsection encoding__windows__functions__utf16_utf32 UTF-8 to/from UTF-16/UTF-32 Conversion
+
+Available on Windows with Microsoft STL for conversion between UTF encodings:
+
+\code
+#include <yycc/encoding/windows.hpp>
+
+// Example: Converting UTF-8 to UTF-16
+std::u8string utf8_text = u8"Hello, 世界!";
+auto result = to_utf16(utf8_text);
+if (result.has_value()) {
+    std::u16string utf16_text = result.value();
+    // Use utf16_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-16 to UTF-8
+std::u16string utf16_text = u"Hello, 世界!";
+auto result = to_utf8(utf16_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-8 to UTF-32
+std::u8string utf8_text = u8"Hello, 世界! 🌍";
+auto result = to_utf32(utf8_text);
+if (result.has_value()) {
+    std::u32string utf32_text = result.value();
+    // Use utf32_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\code
+// Example: Converting UTF-32 to UTF-8
+std::u32string utf32_text = U"Hello, 世界! 🌍";
+auto result = to_utf8(utf32_text);
+if (result.has_value()) {
+    std::u8string utf8_text = result.value();
+    // Use utf8_text...
+} else {
+    // Handle conversion error
+}
+\endcode
+
+\section encoding__windows__error_handling Error Handling
+
+All functions in this module return a result containing either 
+a ConvError struct represents conversion errors, or the final converted string.
+
+\code
+#include <yycc/encoding/windows.hpp>
+
+std::wstring invalid_text = /* some problematic string */;
+auto result = to_char(invalid_text, CP_UTF8);
+
+if (result.has_value()) {
+    std::string converted = result.value();
+    // Process successfully converted string
+} else {
+    // Handle conversion failure
+    std::cout << "Conversion failed\n";
+}
+\endcode
+
+*/
+}

doc/src/encoding_helper.dox

@@ -1,148 +0,0 @@
-namespace YYCC::EncodingHelper {
-/**
-
-\page encoding_helper Encoding Helper
-
-YYCC::EncodingHelper namespace include all encoding related functions:
-
-\li The convertion between ordinary string and UTF8 string which has been introduced in chapter \ref library_encoding.
-\li Windows specific convertion between \c WCHAR, UTF8 string and string encoded by other encoding.
-\li The convertion among UTF8, UTF16 and UTF32.
-
-\section encoding_helper__ordinary_utf8_conv Ordinary & UTF8 Convertion
-
-These convertion functions have been introduced in previous page.
-See \ref library_encoding for more infomation.
-
-YYCC supports following convertions:
-
-\li #ToUTF8: Convert ordinary string to UTF8 string.
-\li #ToUTF8View: Same as ToUTF8, but return string view instead.
-\li #ToOrdinary: Convert UTF8 string to ordinary string.
-\li #ToOrdinaryView: Same as ToOrdinary, but return string view instead.
-
-\section encoding_helper__win_conv Windows Specific Convertion
-
-During Windows programming, the convertion between Microsoft specified \c wchar_t and \c char is an essential operation.
-Because Windows has 2 different function system, the functions ended with A and the functions ended with W.
-(Microsoft specified \c wchar_t is \c 2 bytes long. It's different with Linux defined common 4 bytes long).
-Thus YYCC provides these convertion functions in Windows to help programmer have better programming experience.
-
-These functions are Windows specific, so they will be invisible in other platforms.
-Please use them carefully (make sure that you are using them only in Windows environment).
-
-YYCC supports following convertions:
-
-\li #WcharToChar: Convert \c wchar_t string to code page specified string.
-\li #CharToWchar: The reversed convertion of WcharToChar.
-\li #CharToChar: Convert string between 2 different code pages. It's a shortcut of calling CharToWchar and WcharToChar successively.
-\li #WcharToUTF8: Convert \c wchar_t string to UTF8 string.
-\li #UTF8ToWchar: The reversed convertion of WcharToUTF8.
-\li #CharToUTF8: Convert code page specified string to UTF8 string.
-\li #UTF8ToChar: The reversed convertion of CharToUTF8.
-
-Code Page is a Windows concept.
-If you don't understand it, please view corresponding Microsoft documentation.
-
-\section encoding_helper__utf_conv UTF8 UTF16 UTF32 Convertion
-
-The convertion between UTF8, UTF16 and UTF32 is not common but essential.
-These convertions can be achieved by standard library functions and classes.
-(they are actually done by standard library functions in our implementation)
-But we provided functions are easy to use and have clear interface.
-
-These functions are different with the functions introduced above.
-They can be used in any platform, not confined in Windows platforms.
-
-YYCC supports following convertions:
-
-\li #UTF8ToUTF16: Convert UTF8 string to UTF16 string.
-\li #UTF16ToUTF8: The reversed convertion of UTF8ToUTF16.
-\li #UTF8ToUTF32: Convert UTF8 string to UTF32 string.
-\li #UTF32ToUTF8: The reversed convertion of UTF8ToUTF32.
-
-\section encoding_helper__overloads Function Overloads
-
-Every encoding convertion functions (except the convertion between UTF8 and ordinary string) have 4 different overloads for different scenarios.
-Take #WcharToChar for example.
-There are following 4 overloads:
-
-\code
-bool WcharToChar(const std::wstring_view& src, std::string& dst, UINT code_page);
-bool WcharToChar(const wchar_t* src, std::string& dst, UINT code_page);
-std::string WcharToChar(const std::wstring_view& src, UINT code_page);
-std::string WcharToChar(const wchar_t* src, UINT code_page);
-\endcode
-
-\subsection encoding_helper__overloads_destination Destination String
-
-According to the return value, these 4 overload can be divided into 2 types.
-The first type returns bool. The second type returns \c std::string instance.
-
-For the first type, it always return bool to indicate whether the convertion is success.
-Due to this, the function must require an argument for holding the result string.
-So you can see the functions belonging to this type always require a reference to \c std::string in argument.
-
-Oppositely, the second directly returns result by return value.
-It doesn't care the success of convertion and will return empty string if convertion failed.
-Programmer can more naturally use it because the retuen value itself is the result.
-There is no need to declare a variable before calling convertion function for holding result.
-
-All in all, the first type overload should be used in strict scope.
-The success of convertion will massively affect the behavior of your following code.
-For example, the convertion code is delivered to some system function and it should not be empty and etc.
-The second type overload usually is used in lossen scenarios.
-For exmaple, this overload usually is used in console output because it usually doesn't matter.
-There is no risk even if the convertion failed (just output a blank string).
-
-For the first type, please note that there is \b NO guarantee that the argument holding return value is not changed.
-Even the convertion is failed, the argument holding return value may still be changed by function itself.
-
-In this case, the type of result is \c std::string because this is function required.
-In other functions, such as #WcharToUTF8, the type of result can be \c yycc_u8string or etc.
-So please note the type of result is decided by convertion function itself, not only \c std::string.
-
-\subsection encoding_helper__overloads__source Source String
-
-According to the way providing source string,
-these 4 overload also can be divided into 2 types.
-The first type take a reference to constant \c std::wstring_view.
-The second type take a pointer to constant \c wchar_t.
-
-For first type, it will take the whole string for convertion, including \b embedded NUL terminal.
-Please note we use string view as argument.
-It is compatible with corresponding raw string pointer and string container.
-So it is safe to directly pass \c std::wstring for this function.
-
-For second type, it will assume that you passed argument is a NUL terminated string and send it for convertion.
-
-The result is clear.
-If you want to process string with \b embedded NUL terminal, please choose first type overload.
-Otherwise the second type overload is enough.
-
-Same as destination string, the type of source is also decided by the convertion function itself.
-For exmaple, the type of source in #UTF8ToWchar is \c yycc_u8string_view and \c yycc_char8_t, 
-not \c std::wstring and \c wchar_t.
-
-\subsection encoding_helper__overloads__extra Extra Argument
-
-There is an extra argument called \c code_page for #WcharToChar.
-It indicates the code page of destination string,
-because this function will convert \c wchar_t string to the string with specified code page encoding.
-
-Some convertion functions have extra argument like this,
-because they need more infomations to decide what they need to do.
-Some convertion functions don't have extra argument.
-For exmaple, the convertion between \c wchar_t string and UTF8 string.
-Because both source string and destination string are concrete.
-There is no need to provide any more infomations.
-
-\subsection encoding_helper__overloads__conclusion Conclusion
-
-Mixing 2 types of source string and 2 types of destination string,
-we have 4 different overload as we illustrated before.
-Programmer can use them freely according to your requirements.
-And don't forget to provide extra argument if function required.
-
-*/
-}

doc/src/env.dox

@@ -0,0 +1,85 @@
+namespace yycc::env {
+/**
+
+\page env Environment Operations
+
+This namespace provide various environment operations inspired by Rust standard library.
+
+\section env__var Environment Variable Operations
+
+These functions allow manipulation of environment variables with proper error handling using \c std::expected.
+
+\li get_var(): Get the value of a given environment variable name
+\li set_var(): Set the value of a given environment variable name
+\li del_var(): Delete environment variable with given name
+\li get_vars(): Get all environment variables as a list of name-value pairs
+
+There is an example usage of these functions below:
+
+\code
+#include <yycc/env.hpp>
+
+auto result = yycc::env::get_var(u8"PATH");
+if (result.has_value()) {
+    auto value = result.value();
+    // Use the value...
+} else {
+    // Handle the error
+}
+\endcode
+
+\section env__path Path Operations
+
+These functions provide access to various important paths in the system environment.
+
+\li current_dir(): Returns the current working directory
+\li current_exe(): Returns the path of the current running executable
+\li home_dir(): Returns the path of the current user's home directory if known
+\li temp_dir(): Returns the path of a temporary directory
+
+There is an example usage of these functions below:
+
+\code
+#include <yycc/env.hpp>
+#include <yycc/patch/stream.hpp>
+#include <iostream>
+
+using namespace yycc::patch::stream;
+
+auto cwd_result = yycc::env::current_dir();
+if (cwd_result.has_value()) {
+    std::cout << "Current directory: " << cwd_result.value() << std::endl;
+}
+
+auto exe_result = yycc::env::current_exe();
+if (exe_result.has_value()) {
+    std::cout << "Executable path: " << exe_result.value() << std::endl;
+}
+\endcode
+
+\section env__arg Command Line Argument Operations
+
+These functions provide access to command-line arguments passed to the program.
+
+\li get_args(): Returns the arguments that this program was started with
+
+There is an example usage of these functions below:
+
+\code
+#include <yycc/env.hpp>
+#include <yycc/patch/stream.hpp>
+#include <iostream>
+
+using namespace yycc::patch::stream;
+
+auto args_result = yycc::env::get_args();
+if (args_result.has_value()) {
+    auto args = args_result.value();
+    for (auto& arg : args) {
+        std::cout << "Arg: " << arg << std::endl;
+    }
+}
+\endcode
+
+*/
+}

doc/src/index.dox

@@ -10,7 +10,7 @@
   <TD><CENTER>
     <B>YYCCommonplace Programming Manual</B>
 
-    Copyright 2024 by yyc12345.
+    Copyright 2024-2026 by yyc12345.
   </CENTER></TD>
 </TR>
 </TABLE>
@@ -25,48 +25,80 @@
 <TR>
   <TD ALIGN="LEFT" VALIGN="TOP">
 
-    <B>General Features</B>
+    <B>Overviews</B>
 
     \li \subpage intro
 
-    \li \subpage library_macros
+    \li \subpage premise_and_principle
 
-    \li \subpage library_encoding
+    <B>STL Enhancements</B>
 
-    \li \subpage encoding_helper
+    \li \subpage macro
 
-    \li \subpage string_helper
+    \li \subpage cenum
 
-    \li \subpage parser_helper
+    \li \subpage string__reinterpret
 
-    \li \subpage console_helper
+    \li \subpage string__op
 
-    \li \subpage io_helper
+    \li \subpage num__parser
 
-    \li \subpage std_patch
+    \li \subpage num__op
 
-    <B>Advanced Features</B>
+    \li \subpage num__safe_cast
 
-    \li \subpage constraints
+    \li \subpage num__safe_op
 
-    \li \subpage config_manager
+    \li \subpage patch
 
-    \li \subpage arg_parser
+    \li \subpage env
+
+    \li \subpage rust
+
+    <B>Text Encoding</B>
+
+    \li \subpage encoding__stl
+
+    \li \subpage encoding__windows
+
+    \li \subpage encoding__iconv
+
+    \li \subpage pycodec
 
   </TD>
   <TD ALIGN="LEFT" VALIGN="TOP">
 
+    <B>Advanced Features (Carton)</B>
+
+    \li \subpage termcolor
+
+    \li \subpage csconsole
+
+    \li \subpage ironpad
+
+    \li \subpage clap
+
+    \li \subpage binstore
+
+    \li \subpage fft
+
+    \li \subpage lexer61
+
+    \li \subpage wcwidth
+
+    \li \subpage tabulate
+
     <B>Windows Specific Features</B>
 
-    \li \subpage win_import
+    \li \subpage windows__import_guard
 
-    \li \subpage com_helper
+    \li \subpage windows__com
 
-    \li \subpage dialog_helper
+    \li \subpage windows__dialog
 
-    \li \subpage win_fct_helper
+    \li \subpage windows__winfct
 
-    \li \subpage exception_helper
+    \li \subpage windows__console
 
   </TD>
 </TR>

doc/src/intro.dox

@@ -6,7 +6,7 @@ YYCCommonplace, or YYC Commonplace (abbr. YYCC),
 is a static library providing various useful C++ functions 
 when programming with standard library or Windows environment.
 
-During the development of a few projects, 
+At the beginning, during the development of a few projects, 
 I gradually understand how Windows make the compromise with the code written by its old developers, 
 and what is developer wanted in contemporary C++ standard library under Windows environment. 
 So I create this static library for all of my C++ project.
@@ -15,6 +15,16 @@ I can use a clear and easy way to manage these codes.
 I can easily fix issues found in project using this library by updating a single project, 
 rather than fixing these duplicated code in each project one by one 
 because all of them share the same implementations.
+This is the origin of the 1.x version of YYCC.
+
+After a few years ago, I start to write in Rust and more complicated codes.
+I was allured by Rust and hope all these feature Rust holded can be adapted into C++,
+so I start to refactor this library in modern way.
+However, the compatibility with low C++ standard version is now become the shortcoming of this library.
+I was forced to considering the compatibility with C++ 17 and it cause a huge work.
+So, after think twice, I decide to drop the support of C++ 17, which the higest C++ standard I can used for Virtools project.
+And increase the standard to C++ 23 directly to have better experience.
+That's the origin of the 2.x version of YYCC.
 
 This project mainly is served for my personal use. 
 But I would be honored if you would like to use this in your project. 
@@ -46,17 +56,18 @@ Thus I can have a similar Linux C++ programming experience on Windows.
 
 The eccentric decision of standard commission also is the reason why I create this library.
 
-\li C++ standard commission loves to bring one feature with N concepts and P assistant classes.
+\li C++ standard commission prefer to provide one function with very fundamental classes and functions
+and programmer need to write too much code to achieve a simple work.
 \li C++ standard commission seems doesn't want to bring any features the programmer urgent needed.
 \li C++ standard commission loves delete programmer loved convenient functions and classes.
 \li etc...
 
 There is not a proper way to \e format a string in C++ until C++ 20 (\c std::format).
 String related functions, such as split, lower, higher, replace, now still not be included in standard library.
-Programmer loved, easy to used UTF8 procession functions and classes was deprecate now and will be removed in future.
+Programmer loved, easy to used encoding convertion functions and classes are deprecate now and will be removed in future.
 
 That's why I create this library.
-I bring these function in this library.
+I bring these functions in this library.
 Not industrial level, but easy to use and have enough performance in my project.
 
 \subsection intro__why__boost Boost Issues
@@ -65,7 +76,7 @@ Bosst is a powerful C++ library. But the shortcoming is overt. It's tooooo big.
 This drawback will be more obvious considering the bad dependency mechanism of C++.
 Although the most of Boost sub-library is header-only, but some library still need to link with Boost.
 It order you download the whole Boost library and extract it in your hard disk.
-Cost more than half hours, 5+ GB disk space and the life time of your disk.
+Cost more than half hour of your life, 5+ GB disk space and the life time of your disk.
 
 The functions belonging to Boost is industrial level.
 But what I want is not industrial level functions.
@@ -74,6 +85,7 @@ I don't need extreme performance. I just want my code works.
 
 So I create this library, bring some Boost functions with ordinary but not bad implementation.
 
+<!--
 \section intro__usage Library Usage
 
 Before using this library, I suggest you read this manual fully to have a full overview of this library.
@@ -116,11 +128,14 @@ Due to the different defination of UTF8 char type,
 C++ 20 program can not use this library built by C++ 17 environment.
 So this switch give you a chance to decide the version of C++ standard used when building.
 The lowest and defult version of C++ standard is 17.
-\li \c -d, \c --no-doc: Specify this if you don't want to build documentation.
+\li \c -d, \c --build-doc: Specify this if you want to build documentation.
 End user usually needs documentation, 
 however if you are the developer of this library, you may need this switch.
 Because documentation take too much disk space and cost a bunch of time for building and copying.
-In default, generator will produce script which build documentation automatically.
+In default, generator will produce script which do not build documentation automatically.
+\li \c -p, \c --pic: Enable Position Independent Code flag on non-Windows platfotm.
+This flag is crucial to linking this library to another dynamic library.
+If you do not specify this flag, the linking process will fail.
 
 After script done, you will find CMake distribution in directory <TT>bin/<I>cpp_ver</I>/install</TT>.
 and you will also find your MSVC distribution in directory <TT>bin/<I>cpp_ver</I>/msvc_install</TT>.
@@ -184,5 +199,5 @@ YYCC CMake build script contains a special option called \c YYCC_DEBUG_UE_FILTER
 If you set it to true, it will add a public macro \c YYCC_DEBUG_UE_FILTER to YYCC project.
 This macro will enable special code path for the convenience of debugging \ref exception_helper related features.
 So in common use, user should not enable this option.
-
+-->
 */

doc/src/io_helper.dox

@@ -1,50 +0,0 @@
-namespace YYCC::IOHelper {
-/**
-
-\page io_helper IO Helper
-
-Actually, YYCC::IOHelper includes functions which can not be placed in other place.
-
-\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__smart_file Smart FILE Pointer
-
-#SmartStdFile use \c std::unique_ptr with custom deleter to implement smart \c FILE*.
-It is useful in the cases that you want to automatically free opened file when leaving corresponding scope.
-
-\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
-
-*/
-}

doc/src/library_encoding.dox

@@ -1,228 +0,0 @@
-namespace YYCC {
-/**
-
-\page library_encoding Library Encoding
-
-Before using this library, you should know the encoding strategy of this library first.
-In short words, this library use UTF8 encoding everywhere except some special cases,
-for example, function explicitly order the encoding of input parameters.
-
-In following content of this article, you will know the details about how we use UTF8 in this library.
-
-\section library_encoding__utf8_type UTF8 Type
-
-YYCC uses custom UTF8 char type, string container and string view all over the library, from parameters to return value.
-Following content will introduce how we define them.
-
-\subsection library_encoding__utf8_type__char_type Char Type
-
-YYCC library has its own UTF8 char type, \c yycc_char8_t.
-This is how we define it:
-
-\code
-#if defined(__cpp_char8_t)
-using yycc_char8_t = char8_t;
-#else
-using yycc_char8_t = unsigned char;
-#endif
-\endcode
-
-If your environment (higher or equal to C++ 20) supports \c char8_t provided by standard library, \c yycc_char8_t is just an alias to \c char8_t,
-otherwise (lower than C++ 20, e.g. C++ 17), \c yycc_char8_t will be defined as \c unsigned \c char like C++ 20 does (this can be seen as a polyfill).
-
-This means that if you already have used \c char8_t provided by standard library,
-you do not need to do any extra modification before using this library.
-Because all types are compatible.
-
-\subsection library_encoding__utf8_type__container_type String Container and View
-
-We define string container and string view like this:
-
-\code
-using yycc_u8string = std::basic_string<yycc_char8_t>;
-using yycc_u8string_view = std::basic_string_view<yycc_char8_t>;
-\endcode
-
-The real code written in library may be slightly different with this but they have same meanings.
-
-In \c char8_t environment, they are just the alias to \c std::u8string and \c std::u8string_view respectively.
-So if you have already used them, no need to any modification for your code before using this library.
-
-\subsection library_encoding__utf8_type__why Why?
-
-You may curious why I create a new UTF8 char type, rather than using standard library UTF8 char type directly. There are 2 reasons.
-
-First, It was too late that I notice I can use standard library UTF8 char type.
-My UTF8 char type has been used in library everywhere and its tough to fully replace them into standard library UTF8 char type.
-
-Second, UTF8 related content of standard library is \e volatile.
-I notice standard library change UTF8 related functions frequently and its API are not stable.
-For example, standard library brings \c std::codecvt_utf8 in C++ 11, deprecate it in C++ 17 and even remove it in C++ 26.
-That's unacceptable! So I create my own UTF8 type to avoid the scenario that standard library remove \c char8_t in future.
-
-\section library_encoding__concept Concepts
-
-In following content, you may be face with 2 words: ordinary string and UTF8 string.
-
-UTF8 string, as its name, is the string encoded with UTF8.
-The char type of it must is \c yycc_char8_t.
-(equivalent to \c char8_t after C++ 20.)
-
-Ordinary string means the plain, native string.
-The result of C++ string literal without any prefix \c "foo bar" is a rdinary string.
-The char type of it is \c char.
-Its encoding depends on compiler and environment.
-(UTF8 in Linux, or system code page in Windows if UTF8 switch was not enabled in MSVC.)
-
-For more infomation, please browse CppReference:
-https://en.cppreference.com/w/cpp/language/string_literal
-
-\section library_encoding__utf8_literal UTF8 Literal
-
-String literal is a C++ concept.
-If you are not familar with it, please browse related article first, such as CppReference.
-
-\subsection library_encoding__utf8_literal__single Single Literal
-
-In short words, YYCC allow you declare an UTF8 literal like this:
-
-\code
-YYCC_U8("This is UTF8 literal.")
-\endcode
-
-YYCC_U8 is macro.
-You don't need add extra \c u8 prefix in string given to the macro.
-This macro will do this automatically.
-
-In detail, this macro do a \c reinterpret_cast to change the type of given argument to \c const \c yycc_char8_t* forcely.
-This ensure that declared UTF8 literal is compatible with YYCC UTF8 types.
-
-\subsection library_encoding__utf8_literal__char Single Char
-
-Same as UTF8 literal, YYCC allow you cast normal \c char into \c yycc_char8_t as following code:
-
-\code
-YYCC_U8_CHAR('A')
-\endcode
-
-YYCC_U8_CHAR is a macro.
-It just simply use \c static_cast to cast given value to \c yycc_char8_t.
-It doesn't mean that you can cast non-ASCII characters,
-because the space these characters occupied usually more than the maximum value of \c char.
-For example, following code is \b invalid:
-
-\code
-YYCC_U8_CHAR('文') // INVALID!
-\endcode
-
-\subsection library_encoding__utf8_literal__concatenation Literal Concatenation
-
-YYCC_U8 macro also works for string literal concatenation:
-
-\code
-YYCC_U8("Error code: " PRIu32 ". Please contact me.");
-\endcode
-
-According to C++ standard for string literal concatenation, 
-<I>"If one of the strings has an encoding prefix and the other does not, the one that does not will be considered to have the same encoding prefix as the other."</I>
-At the same time, YYCC_U8 macro will automatically add \c u8 prefix for the first component of this string literal concatenation.
-So the whole string will be UTF8 literal.
-It also order you should \b not add any prefix for other components of this string literal concatenation.
-
-\subsection library_encoding__utf8_literal__why Why?
-
-You may know that C++ standard allows programmer declare an UTF8 literal explicitly by writing code like this:
-
-\code
-u8"foo bar"
-\endcode
-
-This is okey. But it may incompatible with YYCC UTF8 char type.
-According to C++ standard, this UTF8 literal syntax will only return \c const \c char8_t* if your C++ standard higher or equal to C++ 20,
-otherwise it will return \c const \c char*.
-This behavior cause that you can not assign this UTF8 literal to \c yycc_u8string if you are in the environment which do not support \c char8_t, 
-because their types are different.
-Thereas you can not use the functions provided by this library because they are all use YYCC defined UTF8 char type.
-
-\section library_encoding__utf8_pointer UTF8 String Pointer
-
-String pointer means the raw pointer pointing to a string, such as \c const \c char*, \c char*, \c char32_t* and etc.
-
-Many legacy code assume \c char* is encoded with UTF8 (the exception is Windows). But \c char* is incompatible with \c yycc_char8_t.
-YYCC provides YYCC::EncodingHelper::ToUTF8 to resolve this issue. There is an exmaple:
-
-\code
-const char* absolutely_is_utf8 = "I confirm this is encoded with UTF8.";
-const yycc_char8_t* converted = YYCC::EncodingHelper::ToUTF8(absolutely_is_utf8);
-
-char* mutable_utf8 = const_cast<char*>(absolutely_is_utf8); // This is not safe. Just for example.
-yycc_char8_t* mutable_converted = YYCC::EncodingHelper::ToUTF8(mutable_utf8);
-\endcode
-
-YYCC::EncodingHelper::ToUTF8 has 2 overloads which can handle constant and mutable stirng pointer convertion respectively.
-
-YYCC also has ability that convert YYCC UTF8 char type to ordinary char type by YYCC::EncodingHelper::ToOrdinary.
-Here is an exmaple:
-
-\code
-const yycc_char8_t* yycc_utf8 = YYCC_U8("I am UTF8 string.");
-const char* converted = YYCC::EncodingHelper::ToOrdinary(yycc_utf8);
-
-yycc_char8_t* mutable_yycc_utf8 = const_cast<char*>(yycc_utf8); // Not safe. Also just for example.
-char* mutable_converted = YYCC::EncodingHelper::ToOrdinary(mutable_yycc_utf8);
-\endcode
-
-Same as YYCC::EncodingHelper::ToUTF8, YYCC::EncodingHelper::ToOrdinary also has 2 overloads to handle constant and mutable string pointer.
-
-\section library_encoding__utf8_container UTF8 String Container
-
-String container usually means the standard library string container, such as \c std::string, \c std::wstring, \c std::u32string and etc.
-
-In many personal project, programmer may use \c std::string everywhere because \c std::u8string may not be presented when writing peoject.
-How to do convertion between ordinary string container and YYCC UTF8 string container?
-It is definitely illegal that directly do force convertion. Because they may have different class layout.
-Calm down and I will tell you how to do correct convertion.
-YYCC provides YYCC::EncodingHelper::ToUTF8 to convert ordinary string container to YYCC UTF8 string container.
-There is an exmaple:
-
-\code
-std::string ordinary_string("I am UTF8");
-yycc_u8string yycc_string = YYCC::EncodingHelper::ToUTF8(ordinary_string);
-auto result = YYCC::EncodingHelper::UTF8ToUTF32(yycc_string);
-\endcode
-
-Actually, YYCC::EncodingHelper::ToUTF8 accepts a reference to \c std::string_view as argument.
-However, there is a implicit convertion from \c std::string to \c std::string_view, 
-so you can directly pass a \c std::string instance to it.
-
-String view will reduce unnecessary memory copy.
-If you just want to pass ordinary string container to function, and this function accepts \c yycc_u8string_view as its argument,
-you can use alternative YYCC::EncodingHelper::ToUTF8View.
-
-\code
-std::string ordinary_string("I am UTF8");
-yycc_u8string_view yycc_string = YYCC::EncodingHelper::ToUTF8View(ordinary_string);
-auto result = YYCC::EncodingHelper::UTF8ToUTF32(yycc_string);
-\endcode
-
-Comparing with previous one, this example use less memory.
-The reduced memory is the content of \c yycc_string because string view is a view, not the copy of original string.
-
-Same as UTF8 string pointer, we also have YYCC::EncodingHelper::ToOrdinary and YYCC::EncodingHelper::ToOrdinaryView do correspondant reverse convertion.
-Try to do your own research and figure out how to use them.
-It's pretty easy.
-
-\section library_encoding__windows Warnings to Windows Programmer
-
-Due to the legacy of MSVC, the encoding of \c char* may not be UTF8 in most cases.
-If you run the convertion code introduced in this article with the string which is not encoded with UTF8, it may cause undefined behavior.
-
-To enable UTF8 mode of MSVC, please deliver \c /utf-8 switch to MSVC.
-Thus you can use the functions introduced in this article safely.
-Otherwise, you must guarteen that the argument you provided to these functions is encoded by UTF8 manually.
-
-Linux user do not need care this.
-Because almost Linux distro use UTF8 in default.
-
-*/
-}

doc/src/library_macros.dox

@@ -1,80 +0,0 @@
-namespace YYCC {
-/**
-
-\page library_macros Library Macros
-
-In this page we will introduce the macros defined by this library
-which can not be grouped in other topic.
-
-\section library_macros__platform_checker Platform Checker
-
-In many cross platform applications, 
-programmer usually write code adapted to different platforms in one source file 
-and enable them respectively by macros representing the target platform.
-As a cross platform library,
-YYCC also has this feature and you can utilize it if you don't have other ways to so the same things.
-
-\subsection library_macros__platform_checker__values Values
-
-YYCC always define a macro called \c YYCC_OS to indicate the system of target platform.
-In implementation, it will check following list from top to bottom to set matched value for it.
-
-\li \c YYCC_OS_WINDOWS: Windows environment. It is done by checking whether environment define \c _WIN32 macro.
-\li \c YYCC_OS_LINUX: In current implementation, this means target platform is \b NOT Windows.
-
-\subsection library_macros__platform_checker__usage Usage
-
-Now you know any possible value of \c YYCC_OS.
-The next step is how to use it to enable specified code in specific target platform.
-We take Windows platform for example.
-Assume \c blabla() function is Windows specific.
-We have following example code:
-
-\code
-#if YYCC_OS == YYCC_OS_WINDOWS
-blabla();
-#endif
-\endcode
-
-It's enough and simple that use \c \#if to bracket the Windows specified code.
-
-\section library_macros__batch_class_copy_move Batch Class Copy / Move Functions
-
-YYCC provides 6 macros to batchly remove class copy constructor and move constructor,
-or set default class copy constructor and move constructor.
-
-<UL>
-    <LI>
-    \c YYCC_DEL_CLS_COPY: Declare following 2 statements which delete copy constrcutor and copy assign operator.
-    <UL>
-        <LI><TT>CLSNAME(const CLSNAME&) = delete;</TT></LI>
-        <LI><TT>CLSNAME& operator=(const CLSNAME&) = delete;</TT></LI>
-    </UL>
-    </LI>
-    <LI>
-    \c YYCC_DEL_CLS_MOVE: Declare following 2 statements which delete move constrcutor and move assign operator.
-    <UL>
-        <LI><TT>CLSNAME(CLSNAME&&) = delete;</TT></LI>
-        <LI><TT>CLSNAME& operator=(CLSNAME&&) = delete;</TT></LI>
-    </UL>
-    </LI>
-    <LI>\c YYCC_DEL_CLS_COPY_MOVE: The combination of \c YYCC_DEL_CLS_COPY and \c YYCC_DEL_CLS_MOVE.</LI>
-    <LI>
-    \c YYCC_DEF_CLS_COPY: Declare following 2 statements which set default copy constrcutor and copy assign operator.
-    <UL>
-        <LI><TT>CLSNAME(const CLSNAME&) = default;</TT></LI>
-        <LI><TT>CLSNAME& operator=(const CLSNAME&) = default;</TT></LI>
-    </UL>
-    </LI>
-    <LI>
-    \c YYCC_DEF_CLS_MOVE: Declare following 2 statements which set default move constrcutor and move assign operator.
-    <UL>
-        <LI><TT>CLSNAME(CLSNAME&&) = default;</TT></LI>
-        <LI><TT>CLSNAME& operator=(CLSNAME&&) = default;</TT></LI>
-    </UL>
-    </LI>
-    <LI>\c YYCC_DEF_CLS_COPY_MOVE: The combination of \c YYCC_DEF_CLS_COPY and \c YYCC_DEF_CLS_MOVE.</LI>
-</UL>
-
-*/
-}

doc/src/macro.dox

@@ -0,0 +1,323 @@
+namespace yycc::macro {
+/**
+
+\page macro Library Macros
+
+In this page we will introduce the macros defined by this library
+which can not be grouped in other topic.
+
+\section macro__version Library Version
+
+Version is a important things in modern software development, especially for a library.
+In YYCC, we use Semantic Versioning as our version standard.
+For more infomations about it, please see: https://semver.org/
+
+First, YYCC has its own version and it can be visited by
+\c YYCC_VER_MAJOR, \c YYCC_VER_MINOR, and \c YYCC_VER_PATCH.
+Each part of Semantic Versioning is provided individually.
+
+\section macro__version_cmp Version Comparison
+
+YYCC also provide a bunch of macros to compare 2 versions.
+It also provides a way to check YYCC version in program using YYCC,
+because some of them rely on a specific version of YYCC.
+There is a list of these comparison macros.
+
+\li YYCC_VERCMP_E
+\li YYCC_VERCMP_NE
+\li YYCC_VERCMP_G
+\li YYCC_VERCMP_GE
+\li YYCC_VERCMP_NL
+\li YYCC_VERCMP_L
+\li YYCC_VERCMP_LE
+\li YYCC_VERCMP_NG
+
+You may notice all of these macros are all start with \c YYCC_VERCMP_,
+and their tails are inspired from x86 ASM comparison jump code.
+For example, \c E means "equal" and \c NE means "not equal",
+\c G means "greater", \c GE means "greater or equal", and \c NG means "not gretaer".
+
+All of these macros take 6 arguments,
+for the first 3 arguments, we call them "left version".
+From left to right they are the major part, minor part and patch part of semantic version.
+And for the last 3 arguments, we call them "right version".
+From left to right they are the major part, minor part and patch part of semantic version.
+There is a example about checking whether YYCC library version is exactly what we wanted version.
+
+\code
+#if YYCC_VERCMP_NE(YYCC_VER_MAJOR, YYCC_VER_MINOR, YYCC_VER_PATCH, 1, 3 ,0)
+#error "Not Matched YYCC Version"
+#endif
+\endcode
+
+\section macro__copy_move Class Copy / Move Functions
+
+YYCC provides several macros to manage copy and move constructors and assignment operators for classes.
+These include macros to delete, default, declare, and implement copy and move operations.
+
+<UL>
+    <LI>
+    \c YYCC_DELETE_COPY(CLSNAME): Explicitly remove copy constructor and copy assignment operator for the given class.
+    <UL>
+        <LI><TT>CLSNAME(const CLSNAME&) = delete;</TT></LI>
+        <LI><TT>CLSNAME& operator=(const CLSNAME&) = delete;</TT></LI>
+    </UL>
+    </LI>
+    <LI>
+    \c YYCC_DELETE_MOVE(CLSNAME): Explicitly remove move constructor and move assignment operator for the given class.
+    <UL>
+        <LI><TT>CLSNAME(CLSNAME&&) noexcept = delete;</TT></LI>
+        <LI><TT>CLSNAME& operator=(CLSNAME&&) noexcept = delete;</TT></LI>
+    </UL>
+    </LI>
+    <LI>\c YYCC_DELETE_COPY_MOVE(CLSNAME): The combination of \c YYCC_DELETE_COPY and \c YYCC_DELETE_MOVE.</LI>
+    <LI>
+    \c YYCC_DEFAULT_COPY(CLSNAME): Explicitly set default copy constructor and copy assignment operator for the given class.
+    <UL>
+        <LI><TT>CLSNAME(const CLSNAME&) = default;</TT></LI>
+        <LI><TT>CLSNAME& operator=(const CLSNAME&) = default;</TT></LI>
+    </UL>
+    </LI>
+    <LI>
+    \c YYCC_DEFAULT_MOVE(CLSNAME): Explicitly set default move constructor and move assignment operator for the given class.
+    <UL>
+        <LI><TT>CLSNAME(CLSNAME&&) noexcept = default;</TT></LI>
+        <LI><TT>CLSNAME& operator=(CLSNAME&&) noexcept = default;</TT></LI>
+    </UL>
+    </LI>
+    <LI>\c YYCC_DEFAULT_COPY_MOVE(CLSNAME): The combination of \c YYCC_DEFAULT_COPY and \c YYCC_DEFAULT_MOVE.</LI>
+    <LI>
+    \c YYCC_DECL_COPY(CLSNAME): Make declaration of copy constructor and assignment operator for the given class to avoid typos.
+    <UL>
+        <LI><TT>CLSNAME(const CLSNAME&);</TT></LI>
+        <LI><TT>CLSNAME& operator=(const CLSNAME&);</TT></LI>
+    </UL>
+    </LI>
+    <LI>
+    \c YYCC_DECL_MOVE(CLSNAME): Make declaration of move constructor and assignment operator for the given class to avoid typos.
+    <UL>
+        <LI><TT>CLSNAME(CLSNAME&&) noexcept;</TT></LI>
+        <LI><TT>CLSNAME& operator=(CLSNAME&&) noexcept;</TT></LI>
+    </UL>
+    </LI>
+    <LI>\c YYCC_DECL_COPY_MOVE(CLSNAME): The combination of \c YYCC_DECL_COPY and \c YYCC_DECL_MOVE.</LI>
+    <LI>\c YYCC_IMPL_COPY_CTOR(CLSNAME, RHS): Make implementation signature of copy constructor for the given class with the right operand name to avoid typos.</LI>
+    <LI>\c YYCC_IMPL_COPY_OPER(CLSNAME, RHS): Make implementation signature of copy assignment operator for the given class with the right operand name to avoid typos.</LI>
+    <LI>\c YYCC_IMPL_MOVE_CTOR(CLSNAME, RHS): Make implementation signature of move constructor for the given class with the right operand name to avoid typos.</LI>
+    <LI>\c YYCC_IMPL_MOVE_OPER(CLSNAME, RHS): Make implementation signature of move assignment operator for the given class with the right operand name to avoid typos.</LI>
+</UL>
+
+Please note that \c YYCC_DECL_ and \c YYCC_IMPL_ should be used together.
+These macros are designed to make sure that you write correct function signatures.
+There is an example about how to use it.
+In HPP file, you can write:
+
+\code
+class Foo {
+    YYCC_DECL_COPY_MOVE(Foo)
+};
+\endcode
+
+And in corresponding CPP file, you should write:
+
+\code
+YYCC_IMPL_COPY_CTOR(Foo, rhs)
+{
+    // Copy members from rhs
+}
+YYCC_IMPL_COPY_OPER(Foo, rhs)
+{
+    // Copy members from rhs
+    return *this;
+}
+YYCC_IMPL_MOVE_CTOR(Foo, rhs)
+{
+    // Move members from rhs
+}
+YYCC_IMPL_MOVE_OPER(Foo, rhs)
+{
+    // Move members from rhs
+    return *this;
+}
+\endcode
+
+\section macro__platform_checker OS Detector
+
+In many cross platform applications, 
+programmer usually write code adapted to different platforms in one source file 
+and enable them respectively by macros representing the target platform.
+As a cross platform library,
+YYCC also has this feature and you can utilize it if you don't have other ways to so the same things.
+
+\subsection macro__platform_checker__macro Macro
+
+YYCC always define <B>one of following macros</B> to indicate the system of target platform.
+
+\li \c YYCC_OS_WINDOWS: Windows environment.
+\li \c YYCC_OS_LINUX: Linux environment.
+\li \c YYCC_OS_MACOS: macOS environment.
+
+Assume \c blabla() function is Windows specific.
+There is an example about how to use it:
+
+\code
+#if defined(YYCC_OS_WINDOWS)
+// Code specific to Windows
+blabla();
+#endif
+\endcode
+
+\subsection macro__platform_checker__constexpr_function Constexpr Function
+
+Additionally, YYCC also provides a bunch of constexpr functions to check whether the target platform is what we want.
+More precisely, os::get_os() function returns an enum value os::OsKind indicating the target platform.
+
+There is an example about how to use it:
+
+\code
+if constexpr (os::get_os() == os::OsKind::Windows) {
+    // Code specific to Windows
+    blabla();
+}
+\endcode
+
+\section macro__compiler_detector Compiler Detector
+
+YYCC provides macros and constexpr functions to detect the compiler being used for compilation.
+
+\subsection macro__compiler_detector__macro Macro
+
+YYCC defines <B>one of following macros</B> to indicate which compiler is being used.
+
+\li \c YYCC_CC_MSVC: MSVC compiler (Microsoft Visual C++)
+\li \c YYCC_CC_GCC: GCC compiler (GNU Compiler Collection)
+\li \c YYCC_CC_CLANG: Clang compiler
+
+There is an example about how to use it:
+
+\code
+#if defined(YYCC_CC_MSVC)
+// Code specific to MSVC
+blabla();
+#endif
+\endcode
+
+\subsection macro__compiler_detector__constexpr_function Constexpr Function
+
+YYCC also provides a constexpr function to check which compiler is being used at compile time.
+More precisely, compiler::get_compiler() function returns an enum value compiler::CompilerKind indicating the compiler being used.
+
+There is an example about how to use it:
+
+\code
+if constexpr (compiler::get_compiler() == compiler::CompilerKind::Msvc) {
+    // Code specific to MSVC
+    blabla();
+}
+\endcode
+
+\section macro__endian_detector Endian Detector
+
+YYCC provides macros and constexpr functions to detect the endianness of the target platform.
+
+\subsection macro__endian_detector__macro Macro
+
+YYCC always defines <B>one of following macros</B> to indicate the endianness of the target platform.
+
+\li \c YYCC_ENDIAN_LITTLE: Little endian system
+\li \c YYCC_ENDIAN_BIG: Big endian system
+
+There is an example about how to use it:
+
+\code
+#if defined(YYCC_ENDIAN_LITTLE)
+// Code specific to little endian systems
+blabla();
+#endif
+\endcode
+
+\subsection macro__endian_detector__constexpr_function Constexpr Function
+
+YYCC also provides a constexpr function to check the endianness of the target platform.
+More precisely, endian::get_endian() function returns an enum value endian::EndianKind indicating the endianness.
+
+There is an example about how to use it:
+
+\code
+if constexpr (endian::get_endian() == endian::EndianKind::Little) {
+    // Code specific to little endian systems
+    blabla();
+}
+\endcode
+
+\section macro__stl_detector STL Detector
+
+YYCC provides macros to detect which Standard Template Library (STL) implementation is being used.
+
+\subsection macro__stl_detector__macro Macro
+
+YYCC defines <B>one of following macros</B> to indicate which STL implementation is being used.
+
+\li \c YYCC_STL_MSSTL: Microsoft STL
+\li \c YYCC_STL_GNUSTL: GNU STL
+\li \c YYCC_STL_CLANGSTL: Clang STL
+
+There is an example about how to use it:
+
+\code
+#if defined(YYCC_STL_MSSTL)
+// Code specific to Microsoft STL
+blabla();
+#endif
+\endcode
+
+\subsection macro__stl_detector__constexpr_function Constexpr Function
+
+YYCC also provides a constexpr function to check which STL implementation is being used at compile time.
+More precisely, stl::get_stl() function returns an enum value stl::StlKind indicating the STL implementation.
+
+There is an example about how to use it:
+
+\code
+if constexpr (stl::get_stl() == stl::StlKind::MsStl) {
+    // Code specific to Microsoft STL
+    blabla();
+}
+\endcode
+
+\section macro__ptr_size_detector Pointer Size Detector
+
+YYCC provides macros and constexpr functions to detect the pointer size of the target platform.
+
+\subsection macro__ptr_size_detector__macro Macro
+
+YYCC always define <B>one of following macros</B> to indicate the pointer size of target platform.
+
+\li \c YYCC_PTRSIZE_32: 32-bit environment
+\li \c YYCC_PTRSIZE_64: 64-bit environment
+
+There is an example about how to use it:
+
+\code
+#if defined(YYCC_PTRSIZE_32)
+// Code specific to 32-bit environment
+blabla();
+#endif
+\endcode
+
+\subsection macro__ptr_size_detector__constexpr_function Constexpr Function
+
+YYCC also provides a constexpr function to check the pointer size of the target platform.
+More precisely, ptr_size::get_ptr_size() function returns an enum value ptr_size::PtrSizeKind indicating the pointer size.
+
+There is an example about how to use it:
+
+\code
+if constexpr (ptr_size::get_ptr_size() == ptr_size::PtrSizeKind::Bits32) {
+    // Code specific to 32-bit environment
+    blabla();
+}
+\endcode
+
+*/
+}

doc/src/num/op.dox

@@ -0,0 +1,30 @@
+namespace yycc::num::op {
+/**
+
+\page num__op Numeric Operations
+
+Namespace yycc::num::op provides functions for robust numeric operations inspired by Rust's approach to primitive type operations.
+
+Currently, this namespace only supports unsigned integer ceiling division, though more operations may be added in the future based on demand.
+
+\section num__op__div_ceil Ceiling Division
+
+The \c div_ceil function performs division between two unsigned integers and rounds up the result. 
+It uses a safe algorithm that avoids potential overflow issues that could occur with the traditional formula <TT>(lhs + rhs - 1) / rhs</TT>.
+
+The function computes: <TT>(lhs % rhs == 0) ? (lhs / rhs) : (lhs / rhs) + 1u</TT>
+The function prevents division by zero by checking the divisor before performing the operation and throwing a std::logic_error if the divisor is zero.
+
+Here are some examples showing how to use this function:
+
+\code
+#include <yycc/num/op.hpp>
+
+// Ceiling division examples
+uint32_t result1 = op::div_ceil(uint32_t(10), uint32_t(3)); // Results in 4
+uint32_t result2 = op::div_ceil(uint32_t(9), uint32_t(3));  // Results in 3
+uint32_t result3 = op::div_ceil(uint32_t(1), uint32_t(10)); // Results in 1
+\endcode
+
+*/
+}

doc/src/num/parser.dox

@@ -0,0 +1,70 @@
+namespace yycc::num::parse {
+/**
+
+\page num__parser Numeric Parser
+
+Namespace yycc::num::parse is served for the convertion from string to number.
+
+\section num__parser__supported_types Supported Types
+
+Functions located in this namespace support the convertion from string to following types:
+
+\li Integral types (except \c bool): \c int, \c uint32_t, \c char and etc.
+\li Floating point types: \c float, \c double and etc.
+\li \c bool
+
+Please note in C++, \c bool is integral type but we list it individually because parser will treat it specially.
+For \c bool type, parser will try doing convertion between it and \c "true" \c "false" string.
+(\b case-insensitive. It means that \c "true", \c "True" and \c "TRUE", all of them can be converted into \c true.)
+
+\section num__parser__usage Usage
+
+This namespace provide a uniform parser function #parse with various overloads.
+All of them accept an UTF8 string view at first argument,
+and following argument is different required by different overloads which may change parser behavior.
+For example, for floating point type, this function allows caller to specify extra argument providing the format of given number string (\c std::chars_format).
+or for integral type, this function allows caller to specify extra argument providing the base of given number string.
+The return value is a result type, containing converted value or error occurs.
+There are some examples:
+
+\code
+auto rv = parse::parse<uint32_t>(u8"123");
+assert(rv.has_value());
+auto converted = rv.value();
+\endcode
+
+\section num__parser__stringify Stringify
+
+Namespace yycc::num::stringify provide the opposite function of namespace yycc::num::parse.
+They convert given number into their string representation.
+There is an example:
+
+\code
+auto showcase = stringify::stringify<uint32_t>(UINT32_C(114));
+\endcode
+
+Same as parse::parse, stringify::stringify also has same overloads and different second arguments.
+For floating point type, this function allows caller to specify extra arguments
+which provides the format (\c std::chars_format) and precision when getting string representation.
+For integral type, this function allows caller to specify extra argument
+providing the base of number when getting string representation.
+However, the result value of stringify::stringify is just the result, not a result type.
+Because it is mostly impossible to occur error in stringify::stringify.
+
+\section num__parser__notes Notes
+
+All functions located in yycc::num::parse and yycc::num::stringify namespace are implementated by standard library functions.
+These functions just make a good wrapper for complex standard library functions.
+And give you a experience like Rust \c parse functions.
+
+Basically, all functions located in this helper have possibility to throw exception.
+But this possibility are more close to the possibility that \c new statement throw \c std::bad_alloc.
+So in most cases you can assume these functions will not throw any exception.
+
+All functions are template functions.
+The argument of template is the type these functions need to be processed.
+Although C++ have \e smart template type deduction, 
+it would be better to specify template argument manually to explicitly specify your desired type.
+
+*/
+}

doc/src/num/safe_cast.dox

@@ -0,0 +1,63 @@
+namespace yycc::num::safe_cast {
+/**
+
+\page num__safe_cast Numeric Safe Casting
+
+Namespace yycc::num::safe_cast provides functions which safely cast numeric value from one type to another.
+
+\section num__safe_cast__overview Overview
+
+When writing C++ code, casting between types with different ranges is very important 
+but greatly easy to make mistakes which finally cause fatal errors. 
+Inspired by Rust's approach to type conversion, 
+this namespace provides safe casting functions that handle potential overflow and underflow issues.
+
+\section num__safe_cast__functions Functions
+
+The namespace provides two main functions:
+\li \c to() - Direct conversion for cases where the destination type can definitely hold the source value
+which means definitely safe conversions (widening conversions).
+\li \c try_to() - Attempt conversion and return a Result type that includes error information if the conversion fails
+which means potentially risky conversions (narrowing conversions).
+
+The \c try_to function returns a \c std::expected.
+If the conversion succeeds, the result contains the converted value.
+If it fails, it contains a error info.
+
+\section num__safe_cast__examples Examples
+
+Here are some examples showing how to use the safe casting functions:
+
+\code
+#include <yycc/num/safe_cast.hpp>
+
+// Safe conversion using 'to' function
+uint32_t val1 = safe_cast::to<uint32_t>(static_cast<int16_t>(123));
+
+// Potentially risky conversion using 'try_to' function
+auto result = safe_cast::try_to<int16_t>(static_cast<int32_t>(12345));
+if (result.has_value()) {
+    auto converted = result.value();
+    // Use converted value
+} else {
+    // Handle error
+}
+\endcode
+
+\section num__safe_cast__notes Notes
+
+The safety of conversions is determined at compile time using the \c CAN_SAFE_TO meta-programming concept.
+However, for variable-length data types (like \c size_t ), the safety determination may vary across platforms,
+which could affect code portability. For this reason, it would be better to use \c try_to for these types
+for better robust application on different platforms.
+
+\section num__safe_cast__limitations Limitations
+
+This namespace supports safe casting between integral types only. 
+Currently unsupported conversions include:
+
+\li Floating-point to floating-point conversions
+\li Floating-point to integer conversions
+
+*/
+}

doc/src/num/safe_op.dox

@@ -0,0 +1,86 @@
+namespace yycc::num::safe_op {
+/**
+
+\page num__safe_op Numeric Safe Arithmetic Operations
+
+Namespace yycc::num::safe_op provides Rust-like safe arithmetic operations 
+for handling overflow, underflow, and other undefined behaviors in C++.
+
+\section num__safe_op__overview Overview
+
+Inspired by Rust's rich set of arithmetic operators, 
+this namespace provides safe arithmetic operations that handle potential overflow, underflow, and other undefined behaviors that commonly occur in C++. 
+It offers multiple strategies for handling arithmetic operations including wrapping, checked, overflowing, saturating, and strict operations.
+
+\section num__safe_op__operation_types Operation Types
+
+The namespace provides several families of arithmetic operations:
+
+\li \c wrapping_* operations: Perform arithmetic with wrapping on overflow/underflow (similar to unsigned integer behavior)
+\li \c checked_* operations: Return std::optional containing the result, or std::nullopt if overflow/underflow occurs
+\li \c overflowing_* operations: Return a pair with the result and a boolean indicating whether overflow occurred
+\li \c saturating_* operations: Clamp the result to the min/max value when overflow/underflow occurs
+\li \c strict_* operations: Throw exceptions when overflow/underflow occurs
+\li \c ordinary operations (add, sub, mul, div): Alias to wrapping operations for safe default behavior
+
+\section num__safe_op__arithmetic_functions Arithmetic Functions
+
+For each operation type, the namespace provides functions for the four basic arithmetic operations:
+\li \c _add : Addition
+\li \c _sub : Subtraction
+\li \c _mul : Multiplication
+\li \c _div : Division
+
+For example, for wrapping operations: \c wrapping_add, \c wrapping_sub, \c wrapping_mul, \c wrapping_div.
+
+\section num__safe_op__examples Examples
+
+Here are some examples showing how to use the safe arithmetic functions:
+
+\code
+#include <yycc/num/safe_op.hpp>
+#include <iostream>
+
+// Wrapping addition - wraps around on overflow
+uint8_t result1 = safe_op::wrapping_add(uint8_t(200), uint8_t(100)); // Results in 44
+
+// Checked multiplication - returns std::optional
+auto result2 = safe_op::checked_mul(int32_t(1000000), int32_t(1000000));
+if (!result2.has_value()) {
+    std::cout << "Multiplication overflowed!" << std::endl;
+} else {
+    std::cout << "Result: " << result2.value() << std::endl;
+}
+
+// Overflowing subtraction - returns pair of result and overflow flag
+auto [result3, overflowed] = safe_op::overflowing_sub(int32_t(-10), int32_t(INT32_MIN));
+if (overflowed) {
+    std::cout << "Subtraction overflowed!" << std::endl;
+}
+
+// Saturating multiplication - clamps to min/max on overflow
+int32_t result4 = safe_op::saturating_mul(int32_t(1000000), int32_t(1000000)); // Clamps to INT32_MAX
+
+// Ordinary operations - safe defaults without undefined behavior
+int32_t result5 = safe_op::add(int32_t(10), int32_t(20)); // 30
+\endcode
+
+\section num__safe_op__undefined_behaviors Handling of Undefined Behaviors
+
+This namespace handles several undefined behaviors in C++ arithmetic:
+\li Signed integer overflow and underflow (e.g. INT_MAX + 1)
+\li Division by zero
+\li Performing INT_MIN / -1 division (which would result in a value that doesn't fit in the type)
+
+For division operations, special care is taken to handle these undefined behaviors appropriately depending on the operation type.
+
+\section num__safe_op__platform_support Platform Support
+
+The implementation uses hardware-specific overflow detection functions:
+\li GCC/Clang: Uses built-in functions like __builtin_add_overflow
+\li Windows: Uses Windows API functions from \c intsafe.h
+
+This ensures optimal performance across different platforms.
+
+*/
+}

doc/src/parser_helper.dox

@@ -1,88 +0,0 @@
-namespace YYCC::ParserHelper {
-/**
-
-\page parser_helper Parser Helper
-
-This helper is served for the convertion between number and string.
-
-\section parser_helper_supported_types Supported Types
-
-Functions located in this helper support the convertion between string and following types:
-
-\li Integral types (except \c bool): \c int, \c uint32_t, \c char and etc.
-\li Floating point types: \c float, \c double and etc.
-\li \c bool
-
-Please note in C++, \c bool is integral type but we list it individually because parser will treat it specially.
-For \c bool type, parser will try doing convertion between it and \c "true" \c "false" string.
-(\b case-insensitive. It means that \c true can be converted from \c "true", \c "True" or \c "TRUE".)
-
-\section parser_helper__try_parse Try Parse
-
-#TryParse will try to parse string into caller specified type.
-All of them accept an UTF8 string view at first argument,
-require that you provide a container receiving converted result in the second argument,
-and return a bool value to indicate whether the convertion is successful.
-There are some examples:
-
-\code
-uint32_t val;
-YYCC::ParserHelper::TryParse<uint32_t>(YYCC_U8("123"), val);
-YYCC::ParserHelper::TryParse<uint32_t>(YYCC_U8("7fff"), val, 16);
-\endcode
-
-For floating point type, this function allows caller to specify extra argument providing the format of given number string (\c std::chars_format).
-For integral type, this function allows caller to specify extra argument providing the base of given number string.
-
-\section parser_helper__parse Parse
-
-#Parse is similar to #TryParse.
-But it will not return bool value to indicate success and doesn't have the argument receiving result.
-It only accepts an UTF8 string view as the only one argument, and return result directly.
-If the convertion failed, the return value is \b undefined (but usually is the default value of given type).
-There is an example:
-
-\code
-uint32_t val = YYCC::ParserHelper::Parse<uint32_t>(YYCC_U8("123"));
-\endcode
-
-For integral and floating point value, 
-it has same extra argument with #TryParse to provide more number infomation.
-
-Using this function is dangerous if the validation of your input is important.
-In this case, please use #TryParse instead.
-
-\section parser_helper__to_string To String
-
-#ToString basically is the reversed operation of #Parse.
-It gets the string representation of given type.
-The only argument of these functions is the type which need to be converted to its string representation.
-And they will return yycc_u8string as result.
-There is an example:
-
-\code
-auto result = YYCC::ParserHelper::ToString<uint32_t>(UINT32_C(114));
-\endcode
-
-For floating point type, this function allows caller to specify extra arguments
-which provides the format (\c std::chars_format) and precision when getting string representation.
-For integral type, this function allows caller to specify extra argument
-providing the base of number when getting string representation.
-
-\section parser_helper__notes Notes
-
-All functions within this helper are implementated by standard library functions.
-These functions just make a good wrapper for complex standard library functions.
-And give you a experience like C\# parser functions.
-
-Basically, all functions located in this helper have possibility to throw exception.
-But this possibility are more close to the possibility that \c new statement throw \c std::bad_alloc.
-So in most cases you can assume these functions will not throw any exception.
-
-All functions are template functions.
-The argument of template is the type these functions need to be processed.
-Although C++ have \e smart template type deduction, 
-it would be better to specify template argument manually to explicitly specify your desired type.
-
-*/
-}

doc/src/patch.dox

@@ -0,0 +1,75 @@
+namespace yycc::patch {
+/**
+
+\page patch Other STL Patches
+
+There are some other STL patches in this library which can not be organized in single document file individually.
+So I put them together here.
+
+\section patch__ptr_pad 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 PRIXPTR_LPAD will help you to resolve this issue.
+
+Macro \c PRIXPTR_LPAD will be expended to one of 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%" PRIXPTR_LPAD PRIXPTR, raw_ptr);
+\endcode
+
+Note \c PRIXPTR is defined by standard library for formatting pointer as hexadecimal style.
+
+\section patch__smart_file Smart FILE Pointer
+
+fopen::SmartStdFile use \c std::unique_ptr with custom deleter to implement smart \c FILE*.
+It is useful in the cases that you want to automatically free opened file when leaving corresponding scope.
+
+\section patch__utf8_fopen UTF8 fopen
+
+In Windows, standard \c std::fopen can not handle UTF8 file name in common environment.
+So we create fopen::fopen 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 = fopen::fopen(u8"/path/to/file", u8"rb");
+\endcode
+
+\section patch__utf8_stream UTF8 Stream Support
+
+The namespace yycc::patch::stream provides UTF8 support for \c std::ostream.
+This namespace contains operator overloads that give \c std::ostream the ability to write UTF8 string and its char.
+To use this feature, you should include its header file first,
+and then directly use <TT>using namespace ::yycc::patch::stream;</TT> to import this namespace.
+
+\section patch__utf8_format UTF8 Format Support
+
+The namespace yycc::patch::format provides a patch for \c std::format to allow UTF8 string as arguments.
+As \c std::format only allows \c char and \c wchar_t as its char type in C++ 23 currently, 
+it's impossible to use UTF8 string for std::format, both as format string and argument.
+This namespace gives a patch for this shortcoming.
+
+First, it define a brandnew format::format function, which resolve the issue that we can not use UTF8 as format string.
+The implementation of this function is simple. We simply convert given UTF8 format string into ordinary string,
+and then delegate it to \c std::vformat, the runtime format function in C++ 23.
+So the performance of this function may be a little worse than \c std::format, but it's not a big deal.
+We suggest that you use this namespace provided format::format function in your code,
+to enable this UTF8 format string feature.
+
+Additionally, this namespace provides \c std::formatter specializations for UTF8 string.
+Thus we can safely use UTF8 string as argument in \c std::format, also including our invented brandnew format::format function.
+
+*/
+}

doc/src/premise_and_principle.dox

@@ -0,0 +1,51 @@
+/**
+
+\page premise_and_principle Premise and Principle
+
+When programming with this library, there is some premise and principle you should noticed.
+
+\section premise_and_principle__exception_is_error Exception is Error
+
+The most crucial spot of this library is <B>"Exception is Error"</B>.
+When some functions throw exception, it should cause program paniked, rather than recover from it.
+This is inspired from Rust, and also the compromise with STL.
+
+Most functions this library provided has Rust-Result-like return value.
+It means that programmer can handle error gracefully.
+However, this library is based on STL, another library that may throw C++ exception to indicate error.
+We can not control this behavior of STL, so I forcely apply this rule.
+
+\section premise_and_principle__os_encoding OS Encoding
+
+This library has special treat with Windows to make it works on Windows.
+However, for other operating system, it do not have too much care.
+We brutally make a premise that other operating systems are POSIX-compatible and use UTF8 as its encoding.
+
+\section premise_and_principle__string_encoding String Encoding
+
+Before using this library, you should know the encoding strategy of this library first.
+After upgrade the whole project into C++23, \c char8_t is the only valid UTF8 char type.
+\c std::u8string and \c std::u8string_view are the only valid UTF8 string container and viewer.
+And, \c u8 string literal prefix is the only way to create UTF8 string literal.
+In brief words, this library use UTF8 encoding everywhere.
+
+However, there are some special cases that use ordinary string instead of UTF8 string list following 
+(also, not all cases are covered).
+
+\li Traditional format function in yycc::string::op.
+Traditional format function provide some overloads for ordinary string formatting.
+That's because this feature is so common to use in some cases.
+\li The message of standard library exception.
+For the compatibility with C++ standard library exception,
+we only can use ordinary string as the message of exception.
+
+\section premise_and_principle__cmake All in CMake
+
+Since YYCC 2.0 version, we do not provide MSVC install layout.
+Any projects use this project should use CMake or CMake-compatible software as its build system.
+
+The reason why we make this decision is that some essential contents are written in CMake files.
+For example, some environment detection macros and Windows environment patches.
+If you do not use CMake, these contents will not be presented in project and cause bad behavior when using this project.
+
+*/

doc/src/rust.dox

@@ -0,0 +1,133 @@
+namespace yycc {
+/**
+
+\page rust Rust Facilities in C++
+
+This collection of following headers brings Rust-style programming facilities to C++. 
+
+\section rust__primitive Primitive Types
+
+The yycc::primitive namespace provides primitive types similar to Rust's approach. 
+Especially resolve the problem that the names of C++ primitive types are so long.
+
+There is an example of using primitive types:
+
+\code
+#include <yycc/primitive.hpp>
+using namespace yycc::primitive;
+
+i32 value = 42;
+u64 big_number = 1000000ULL;
+f64 precision = 3.14159265359;
+\endcode
+
+\section rust__option Option Type
+
+The yycc::option namespace reproduces Rust's Option type and its members Some and None in C++.
+Considering C++ has provide \c std::optional, this namespace provided contents are just an alias to it.
+
+\li yycc::option::Option - Template alias for std::optional
+\li yycc::option::Some - Function to create an Option with a value
+\li yycc::option::None - Function to create an empty Option
+
+There is an example of using \c Option type:
+
+\code
+#include <yycc/option.hpp>
+#include <iostream>
+
+using namespace yycc::option;
+
+Option<int> maybe_value = Some<Option<int>>(42);
+if (maybe_value.has_value()) {
+    std::cout << "Value: " << maybe_value.value() << std::endl;
+}
+
+auto empty_value = None<Option<int>>();
+if (!empty_value.has_value()) {
+    std::cout << "No value present" << std::endl;
+}
+\endcode
+
+\section rust__result Result Type
+
+The yycc::result namespace reproduces Rust's Result type and its members Ok and Err in C++. 
+Considering C++ has provide \c std::expected, this namespace provided contents are just an alias to it.
+
+\li yycc::result::Result - Template alias for std::expected
+\li yycc::result::Ok - Function to create a Result with a success value
+\li yycc::result::Err - Function to create a Result with an error value
+
+There is an example of using \c Result type:
+
+\code
+#include <yycc/result.hpp>
+#include <iostream>
+
+using namespace yycc::result;
+
+Result<int, int> divide(int a, int b) {
+    if (b == 0) {
+        return Err<Result<int, int>>(-1);  // Error code
+    }
+    return Ok<Result<int, int>>(a / b);
+}
+
+auto result = divide(10, 2);
+if (result.has_value()) {
+    std::cout << "Result: " << result.value() << std::endl;
+} else {
+    std::cout << "Error occurred: " << result.error() << std::endl;
+}
+\endcode
+
+\section rust__panic Panic Mechanism
+
+The yycc::panic namespace provides Rust-style panic functionality for immediate program termination on unrecoverable errors. 
+This imitates Rust's panic! macro behavior, allowing the program to immediately exit with error information and stack traces.
+
+\li RS_PANIC: Macro equivalent to Rust's panic! macro. 
+This macro will help you append all filename, line and function info to the real panic trigger function.
+\li yycc::panic::panic: The actual function called by the macro.
+User usually does not need to call this function directly.
+
+There is an example of using this panic mechanism:
+
+\code
+#include <yycc/panic.hpp>
+
+void critical_function(int err_code) {
+    // Some condition that indicates an unrecoverable error
+    if (err_code != 100) {
+        RS_PANIC("Unrecoverable error in critical function with code {}", err_code);
+    }
+}
+\endcode
+
+\section rust__prelude Prelude
+
+The yycc::prelude namespace provides a Rust-like prelude for C++. In Rust, types are automatically imported into all files by default.
+This default-imported set of types is called the "prelude". 
+This namespace provides a similar concept for C++.
+
+This namespace will extract following content into \b global scope:
+
+\li All primitive types defined in yycc::primitive.
+\li Vec: \c std::vector template alias.
+\li All functionality from yycc::option and yycc::result namespaces.
+\li Panic mechanism from yycc::panic.
+
+There is an example of using this header:
+
+\code
+#include <yycc/prelude.hpp>
+
+// Now all Rust-style facilities are available without prefixes:
+i32 x = 42;                    // From primitive
+Vec<i32> numbers = {1, 2, 3};  // Vector of primitive types
+auto result = Ok<Result<i32, i32>>(x);  // Result type
+RS_PANIC("Something went wrong");       // Panic macro
+\endcode
+
+*/
+}

doc/src/std_patch.dox

@@ -1,112 +0,0 @@
-namespace YYCC::StdPatch {
-/**
-
-\page std_patch Standard Library Patch
-
-\section std_patch__starts_with_ends_with Starts With & Ends With
-
-\c std::basic_string::starts_with and \c std::basic_string::ends_with (also available in \c std::basic_string_view)
-are functions introduced in C++ 20 and unavailable in C++ 17.
-YYCC::StdPatch provides a patch for these function in C++ 17 environment.
-Please note these implementations are following implementation instruction presented by CppReference website.
-And it should have the same performance with vanilla functions because Microsoft STL use the same way to implement.
-These implementations will not fallback to vanilla function even they are available.
-Because their performance are good.
-
-To use these functions, you just need to call them like corresponding vanilla functions.
-Our implementations provide all necessary overloads.
-The only thing you need to do is provide the string self as the first argument,
-because our implementations can not be inserted as a class member of string.
-There is an example:
-
-\code
-YYCC::StdPatch::StartsWith(YYCC_U8("aabbcc"), YYCC_U8("aa"));
-YYCC::StdPatch::EndsWith(YYCC_U8("aabbcc"), YYCC_U8("cc"));
-\endcode
-
-\section std_patch__contains Contains
-
-\c Contains function in standard library ordered and unordered successive container are also introduced in C++ 20.
-YYCC::StdPatch provides a patch for this function in C++ 17 environment.
-
-Please note this implementation will fallback to vanilla function if it is available.
-Because our implementation is a remedy (there is no way to use public class member to have the same performance of vanilla function).
-There is an example about how to use it:
-
-\code
-std::set<int> test { 1, 5 };
-YYCC::StdPatch::Contains(test, static_cast<int>(5));
-\endcode
-
-\section std_patch__fs_path std::filesystem::path Patch
-
-As you know, the underlying char type of \c std::filesystem::path is \c wchar_t on Windows,
-and in other platforms, it is simple \c char.
-Due to this, if you try to create a \c std::filesystem::path instance by calling constructor with an UTF8 char sequence on Windows,
-the library implementation will assume your input is based on current Windows code page, not UTF8.
-And the final path stored in \c std::filesystem::path is not what you expcected.
-
-This patch gives you a way to create \c std::filesystem::path 
-and extract path string stored in \c std::filesystem::path with UTF8 encoding.
-This patch namespace always use UTF8 as its argument.
-You should use the functions provided by this namespace on any platforms 
-instead of vanilla \c std::filesystem::path functions.
-However, if your C++ standard is higher than C++ 20,
-you can directly use UTF8 string pointer and string container in \c std::filesystem::path,
-because standard library has supported them.
-This patch only just want to provide an uniform programming experience.
-
-This patch is served for Windows but also works on other plaftoms.
-If you are in Windows, this patch will perform extra operations to achieve goals,
-and in other platforms, they just redirect request to corresponding vanilla C++ functions.
-
-\subsection std_patch__fs_path__from_utf8_path Create Path from UTF8 String
-
-#ToStdPath provides this feature.
-It accepts an string pointer to UTF8 string and try to create \c std::filesystem::path from it.
-Function will throw exception if encoding convertion or constructor self failed.
-There are some example:
-
-\code
-auto foobar_path = YYCC::StdPatch::ToStdPath(YYCC_U8("/foo/bar"));
-auto slashed_path = foobar_path / YYCC::StdPatch::ToStdPath(YYCC_U8("test"));
-auto replaced_ext = foobar_path.replace_extension(YYCC::StdPatch::ToStdPath(YYCC_U8(".txt")));
-\endcode
-
-For first line in example, it is obvious that you can create a \c std::filesystem::path from this function.
-However, for the second and third line in example, what we want to tell you is 
-that you should always use this function in other \c std::filesystem::path functions requiring path string.
-
-\c std::filesystem::path is a very \e conservative class.
-Most of its functions only accept \c std::filesystem::path self as argument.
-For example, \c std::filesystem::path::replace_extension do not accept string as argument.
-It accepts a reference to \c std::filesystem::path as argument.
-(it still is possible that pass string pointer or string container to it because they can be converted to \c std::filesystem::path implicitly.)
-It's great. This is what we expected!
-We now can safely deliver the result generated by our function to these functions,
-and don't need to worry about the encoding of we provided string.
-Because all strings have been converted to \c std::filesystem::path by our function before passing them.
-
-So, the second line will produce \c "/foo/bar/test" 
-and the third line will produce \c "/foo/bar.txt" in any platforms.
-
-You may notice std::filesystem::u8path.
-However it is depracted since C++ 20,
-because \c std::filesystem::path directly supports UTF8 by \c char8_t since C++ 20.
-Because C++ standard is volatile, we create this function to have an uniform programming experience.
-
-\subsection std_patch__fs_path__to_utf8_path Extract UTF8 Path String from Path
-
-#ToUTF8Path provides this feature.
-It basically is the reversed operation of #ToStdPath.
-It is usually used when you have done all path work in \c std::filesystem::path
-and want to get the result.
-There is an example:
-
-\code
-auto foobar_path = YYCC::StdPatch::ToStdPath(YYCC_U8("/foo/bar"));
-auto result = YYCC::StdPatch::ToUTF8Path(foobar_path / YYCC::StdPatch::ToStdPath(YYCC_U8("test")));
-\endcode
-
-*/
-}

doc/src/string/op.dox

@@ -0,0 +1,176 @@
+namespace yycc::string::op {
+/**
+
+\page string__op String Operations
+
+\section string__op__printf Printf VPrintf
+
+yycc::string::op provides 4 functions for formatting string.
+These functions are originally provided to programmer who can not use C++ 20 \c std::format feature.
+However, when this project was migrated to C++23 standard, \c std::format is finally available.
+And we set these functions as the complement to \c std::format feature.
+
+\code
+std::u8string printf(const char8_t* format, ...);
+std::u8string vprintf(const char8_t* format, va_list argptr);
+std::string printf(const char* format, ...);
+std::string vprintf(const char* format, va_list argptr);
+\endcode
+
+#printf and #vprintf is similar to \c std::sprintf and \c std::vsprintf.
+#printf accepts UTF8 format string and variadic arguments specifying data to print.
+This is commonly used by programmer.
+However, #vprintf also do the same work but its second argument is \c va_list, 
+the representation of variadic arguments.
+It is mostly used by other function which has variadic arguments.
+
+The only difference between these function and standard library functions is 
+that you don't need to worry about whether the space of given buffer is enough,
+because these functions help you to calculate this internally.
+
+Once there are some exceptions occurs, such as, not enough memeory, or the bad syntax of format string,
+these functions will throw exception immediately.
+
+\section string__op__replace Replace
+
+yycc::string::op provide 2 functions for programmer do string replacement:
+
+\code
+void replace(std::u8string& strl, const std::u8string_view& from_strl, const std::u8string_view& to_strl);
+std::u8string to_replace(const std::u8string_view& strl, const std::u8string_view& from_strl, const std::u8string_view& to_strl);
+\endcode
+
+The first overload will do replacement in given string container directly.
+The second overload will produce a copy of original string and do replacement on the copied string.
+
+These #replace functions have special treatments for boundary scenarios:
+
+\li If given string is empty, the return value will be empty.
+\li If the character sequence to be replaced is empty string, no replacement will happen.
+\li If the character sequence will be replaced into string is or empty, it will simply delete found character sequence from given string.
+
+\section string__op__join Join
+
+yycc::string::op provide an universal way for joining string and various specialized join functions.
+
+\subsection string__op__join__universal Universal Join Function
+
+Because C++ list types are various.
+There is no unique and convenient way to create an universal join function.
+So we create #JoinDataProvider to describe join context.
+
+Before using universal join function,
+you should setup #JoinDataProvider first, the context of join function.
+It actually is an \c std::function object which can be easily fetched by C++ lambda syntax.
+This function pointer returns \c std::optional<std::u8string_view>,
+which should return \c std::u8string_view for the data to be joined, or \c std::nullopt if there is no more data.
+As you noticed, this is similar to Rust iterator.
+
+Then, you can pass the created #JoinDataProvider object to #join function.
+And specify delimiter at the same time.
+Then you can get the final joined string.
+There is an example:
+
+\code
+std::vector<std::u8string> data {
+    u8"", u8"1", u8"2", u8""
+};
+auto iter = data.cbegin();
+auto stop = data.cend();
+std::u8string joined_string = yycc::string::op::join(
+    [&iter, &stop]() -> std::optional<std::u8string_view> {
+        if (iter == stop) return std::nullopt;
+        return *iter++;
+    }, 
+    delimiter
+);
+\endcode
+
+\subsection string__op__join__specialized Specialized Join Function
+
+Despite universal join function, 
+yycc::string::op also provide a specialized join functions for standard library container.
+For example, the code written above can be written in following code by using this specialized overload.
+The first two argument is just the begin and end iterator.
+However, you must make sure that the iterator can be dereferenced and then implicitly converted to std::u8string_view.
+
+\code
+std::vector<std::u8string> data {
+    u8"", u8"1", u8"2", u8""
+};
+std::u8string joined_string = yycc::string::op::join(data.begin(), data.end(), delimiter);
+\endcode
+
+\section string__op__lower_upper Lower Upper
+
+This namespace provides Python-like string lower and upper function.
+
+\code
+void lower(std::u8string& strl);
+std::u8string to_lower(const std::u8string_view& strl);
+void upper(std::u8string& strl);
+std::u8string to_upper(const std::u8string_view& strl);
+\endcode
+
+The functions start with "to_" prefix accept a string view as argument 
+and return a \b copy whose content are all the lower/upper case of original string.
+The rest of these functions accept a mutable string container as argument and will modify it in place.
+
+\section string__op__strip_trim Strip and Trim
+
+This namespace provides functions for removing leading and trailing characters.
+There are two sets of functions:
+
+\subsection string__op__strip Unicode-aware functions
+
+These functions properly handle Unicode characters when stripping:
+
+\code
+std::u8string_view strip(const std::u8string_view& strl, const std::u8string_view& words);
+std::u8string_view lstrip(const std::u8string_view& strl, const std::u8string_view& words);
+std::u8string_view rstrip(const std::u8string_view& strl, const std::u8string_view& words);
+\endcode
+
+The prefix "l" and "r" are for left and right strip respectively like Python.
+
+\subsection string__op__trim ASCII-only functions
+
+These functions treat each byte as an individual character and are faster for ASCII-only scenarios:
+
+\code
+std::u8string_view trim(const std::u8string_view& strl, const std::u8string_view& words);
+std::u8string_view ltrim(const std::u8string_view& strl, const std::u8string_view& words);
+std::u8string_view rtrim(const std::u8string_view& strl, const std::u8string_view& words);
+\endcode
+
+The difference of "trim" and "strip" is same as their invented time in Java.
+"trim" is inveted at first so its function is confined to ASCII-only strings.
+"strip" is introduced later and it should accept more scenarios like Unicode.
+Although all of "trim" and "strip" can handle Unicode in Java.
+
+\section string__op__split Split
+
+This namespace provides Python-like string split functions.
+It has 3 variants for different use cases:
+
+\code
+LazySplit lazy_split(const std::u8string_view& strl, const std::u8string_view& delimiter);
+std::vector<std::u8string_view> split(const std::u8string_view& strl, const std::u8string_view& delimiter);
+std::vector<std::u8string> split_owned(const std::u8string_view& strl, const std::u8string_view& delimiter);
+\endcode
+
+All these overloads take a string view as the first argument representing the string need to be split.
+The second argument is a string view representing the delimiter for splitting.
+
+The first function #lazy_split returns a LazySplit object that can be used in range-based for loops.
+This is lazy-computed and memory-efficient for large datasets.
+The second function #split returns a vector of string views, which is memory-efficient 
+but the views are only valid as long as the original string remains valid.
+The third function #split_owned returns a vector of strings, which are copies of the original parts.
+
+If the source string (the string need to be split) is empty, or the delimiter is empty,
+the result will only has 1 item and this item is source string itself.
+There is no way that these methods return an empty list, except the code is buggy.
+
+*/
+}

doc/src/string/reinterpret.dox

@@ -0,0 +1,118 @@
+namespace yycc::string::reinterpret {
+/**
+
+\page string__reinterpret String Reinterpret
+
+Now, you have know that we use UTF8 string everywhere in this project
+as we introduced in \ref premise_and_principle__string_encoding.
+Now it's time to know how to fetch UTF8 string from user or anywhere else.
+
+\section string__reinterpret__concept Concepts
+
+In following content, you may be face with 2 words: ordinary string and UTF8 string.
+
+UTF8 string, as its name, is the string encoded with UTF8.
+The char type of it must is \c char8_t.
+
+Ordinary string means the plain, native string.
+The result of C++ string literal without any prefix \c "foo bar" is a rdinary string.
+The char type of it is \c char.
+Its encoding depends on compiler and environment.
+(UTF8 in Linux, or system code page in Windows if UTF8 switch was not enabled in MSVC.)
+
+For more infomation, please browse CppReference:
+https://en.cppreference.com/w/cpp/language/string_literal
+
+\section string__reinterpret__pointer UTF8 String Pointer
+
+String pointer means the raw pointer pointing to a string, such as \c const \c char*, \c char*, \c char32_t* and etc.
+
+Many legacy code assume \c char* is encoded with UTF8 (the exception is Windows). But \c char* is incompatible with \c char8_t.
+YYCC provides as_utf8() to resolve this issue. There is an exmaple:
+
+\code
+const char* absolutely_is_utf8 = "I confirm this is encoded with UTF8.";
+const char8_t* converted = as_utf8(absolutely_is_utf8);
+
+char* mutable_utf8 = const_cast<char*>(absolutely_is_utf8); // This is not safe. Just for example.
+char8_t* mutable_converted = as_utf8(mutable_utf8);
+\endcode
+
+as_utf8() has 2 overloads which can handle constant and mutable stirng pointer convertion respectively.
+
+YYCC also has ability that convert UTF8 char type to ordinary char type by as_ordinary().
+Here is an exmaple:
+
+\code
+const char8_t* utf8 = u8"I am UTF8 string.";
+const char* converted = as_ordinary(utf8);
+
+char8_t* mutable_utf8 = const_cast<char*>(utf8); // Not safe. Also just for example.
+char* mutable_converted = as_ordinary(mutable_utf8);
+\endcode
+
+Same as as_utf8(), as_ordinary() also has 2 overloads to handle constant and mutable string pointer.
+
+\section string__reinterpret__container UTF8 String Container
+
+String container usually means the standard library string container, such as \c std::string, \c std::wstring, \c std::u32string and etc.
+
+In many personal project, programmer may use \c std::string everywhere because \c std::u8string may not be presented when writing peoject.
+How to do convertion between ordinary string container and UTF8 string container?
+It is definitely illegal that directly do force convertion. Because they may have different class layout.
+Calm down and I will tell you how to do correct convertion.
+YYCC provides as_utf8() to convert ordinary string container to UTF8 string container.
+There is an exmaple:
+
+\code
+std::string ordinary_string("I am UTF8");
+std::u8string utf8_string = as_utf8(ordinary_string);
+\endcode
+
+Actually, as_utf8() accepts a reference to \c std::string_view as argument.
+However, there is a implicit convertion from \c std::string to \c std::string_view, 
+so you can directly pass a \c std::string instance to it.
+
+String view will reduce unnecessary memory copy.
+If you just want to pass ordinary string container to function, and this function accepts \c std::u8string_view as its argument,
+you can use alternative as_utf8_view().
+
+\code
+std::string ordinary_string("I am UTF8");
+std::u8string_view utf8_string = as_utf8_view(ordinary_string);
+\endcode
+
+Comparing with previous one, this example use less memory.
+The reduced memory is the content of \c utf8_string because string view is a view, not the copy of original string.
+
+Same as UTF8 string pointer, we also have as_ordinary() and as_ordinary_view() do correspondant reverse convertion.
+Try to do your own research and figure out how to use them.
+It's pretty easy.
+
+\section string__reinterpret__clarification Clarification about Usage Scenario
+
+Let we make a clarification for what this chapter are talking about.
+In these chapter, what we are talking about the convertion between UTF8 string and ordinary string,
+which is originally encoded by UTF-8 but presented by \c char type.
+This spot is crucial. If you apply any functions provided by this namespace to any string which is not encoded by UTF-8,
+for example, trying converting an CP1252 encoded western europe string to UTF-8 via function given by this namespace,
+it must cause <B>undefined behavior</B>.
+
+The correct function for doing these things introduced above is located in yycc::encoding namespace,
+or a more generic module located in yycc::carton::pycodec.
+This namespace is only suit for the convertion of UTF-8 string which was mis-presented by non-<TT>char8_t</TT> types.
+After understand this point, you now can safely use this namespace.
+
+Additionally, due to the legacy of MSVC, the encoding of \c char* may not be UTF8 in most cases.
+If you run the convertion code introduced in this article with the string which is not encoded with UTF8, 
+it may cause undefined behavior.
+
+To enable UTF8 mode of MSVC, please deliver \c /utf-8 switch to MSVC compiler.
+Thus you can use the functions introduced in this article safely.
+Otherwise, you must guarteen that the argument you provided to these functions is encoded by UTF8 manually.
+
+Linux user do not need care this.
+Because almost Linux distro use UTF8 in default.
+
+*/
+}

doc/src/string_helper.dox

@@ -1,149 +0,0 @@
-namespace YYCC::StringHelper {
-/**
-
-\page string_helper String Helper
-
-\section string_helper__printf Printf VPrintf
-
-YYCC::StringHelper provides 4 functions for formatting string.
-These functions are mainly provided to programmer who can not use C++ 20 \c std::format feature.
-
-\code
-bool Printf(yycc_u8string&, const yycc_char8_t*, ...);
-bool VPrintf(yycc_u8string&, const yycc_char8_t*, va_list argptr);
-yycc_u8string Printf(const yycc_char8_t*, ...);
-yycc_u8string VPrintf(const yycc_char8_t*, va_list argptr);
-\endcode
-
-#Printf and #VPrintf is similar to \c std::sprintf and \c std::vsprintf.
-#Printf accepts UTF8 format string and variadic arguments specifying data to print.
-This is commonly used by programmer.
-However, #VPrintf also do the same work but its second argument is \c va_list, 
-the representation of variadic arguments.
-It is mostly used by other function which has variadic arguments.
-
-The only difference between these function and standard library functions is 
-that you don't need to worry about whether the space of given buffer is enough,
-because these functions help you to calculate this internally.
-
-There is the same design like we introduced in \ref encoding_helper.
-There are 2 overloads for #Printf and #VPrintf respectively.
-First overload return bool value and require a string container as argument for storing result.
-The second overload return result string directly.
-As you expected, first overload will return false if fail to format string (this is barely happened).
-and second overload will return empty string when formatter failed.
-
-\section string_helper__replace Replace
-
-YYCC::StringHelper provide 2 functions for programmer do string replacement:
-
-\code
-void Replace(yycc_u8string&, const yycc_u8string_view&, const yycc_u8string_view&);
-yycc_u8string Replace(const yycc_u8string_view&, const yycc_u8string_view&, const yycc_u8string_view&);
-\endcode
-
-The first overload will do replacement in given string container directly.
-The second overload will produce a copy of original string and do replacement on the copied string.
-
-#Replace has special treatments for following scenarios:
-
-\li If given string is empty, the return value will be empty.
-\li If the character sequence to be replaced is empty string, no replacement will happen.
-\li If the character sequence will be replaced into string is or empty, it will simply delete found character sequence from given string.
-
-\section string_helper__join Join
-
-YYCC::StringHelper provide an universal way for joining string and various specialized join functions.
-
-\subsection string_helper__join__universal Universal Join Function
-
-Because C++ list types are various.
-There is no unique and convenient way to create an universal join function.
-So we create #JoinDataProvider to describe join context.
-
-Before using universal join function,
-you should setup #JoinDataProvider first, the context of join function.
-It actually is an \c std::function object which can be easily fetched by C++ lambda syntax.
-This function pointer accept a reference to \c yycc_u8string_view,
-programmer should set it to the string to be joined when at each calling.
-And this function pointer return a bool value to indicate the end of join.
-You can simply return \c false to terminate join process.
-The argument you assigned to argument will not be taken into join process when you return false.
-
-Then, you can pass the created #JoinDataProvider object to #Join function.
-And specify decilmer at the same time.
-Then you can get the final joined string.
-There is an example:
-
-\code
-std::vector<yycc_u8string> data {
-    YYCC_U8(""), YYCC_U8("1"), YYCC_U8("2"), YYCC_U8("")
-};
-auto iter = data.cbegin();
-auto stop = data.cend();
-auto joined_string = YYCC::StringHelper::Join(
-    [&iter, &stop](yycc_u8string_view& view) -> bool {
-        if (iter == stop) return false;
-        view = *iter;
-        ++iter;
-        return true;
-    }, 
-    decilmer
-);
-\endcode
-
-\subsection string_helper__join__specialized Specialized Join Function
-
-Despite universal join function, 
-YYCC::StringHelper also provide a specialized join functions for standard library container.
-For example, the code written above can be written in following code by using this specialized overload.
-The first two argument is just the begin and end iterator.
-However, you must make sure that we can dereference it and then implicitly convert it to yycc_u8string_view.
-Otherwise this overload will throw template error.
-
-\code
-std::vector<yycc_u8string> data {
-    YYCC_U8(""), YYCC_U8("1"), YYCC_U8("2"), YYCC_U8("")
-};
-auto joined_string = YYCC::StringHelper::Join(data.begin(), data.end(), decilmer);
-\endcode
-
-\section string_helper__lower_upper Lower Upper
-
-String helper provides Python-like string lower and upper function.
-Both lower and upper function have 2 overloads:
-
-\code
-yycc_u8string Lower(const yycc_u8string_view&);
-void Lower(yycc_u8string&);
-\endcode
-
-First overload accepts a string view as argument and return a \b copy whose content are all the lower case of original string.
-Second overload accepts a mutable string container as argument and will make all characters stored in it become their lower case.
-You can choose on of them for your flavor and requirements.
-Upper also has similar 2 overloads.
-
-\section string_helper__split Split
-
-String helper provides Python-like string split function.
-It has 2 types for you:
-
-\code
-std::vector<yycc_u8string> Split(const yycc_u8string_view&, const yycc_u8string_view&);
-std::vector<yycc_u8string_view> SplitView(const yycc_u8string_view&, const yycc_u8string_view&);
-\endcode
-
-All these overloads take a string view as the first argument representing the string need to be split.
-The second argument is a string view representing the decilmer for splitting.
-The only difference between these 2 split function are overt according to their names.
-The first split function will return a list of copied string as its split result.
-The second split function will return a list of string view as its split result,
-and it will keep valid as long as the life time of your given string view argument.
-It also means that the last overload will cost less memory if you don't need the copy of original string.
-
-If the source string (the string need to be split) is empty, or the decilmer is empty,
-the result will only has 1 item and this item is source string itself.
-There is no way that these methods return an empty list, except the code is buggy.
-
-*/
-}

doc/src/win_fct_helper.dox

@@ -1,23 +0,0 @@
-namespace YYCC::WinFctHelper {
-/**
-
-\page win_fct_helper Windows Function Helper
-
-This helper give a more convenient way to call Windows functions.
-
-This namespace is Windows specific.
-It will be entirely invisible in other platforms.
-
-Currently this namespace has following functions:
-
-\li #GetCurrentModule: Get the handle to current module.
-\li #GetTempDirectory: Get temporary directory in Windows.
-\li #GetModuleFileName: Get the path to module in file system by given handle.
-\li #GetLocalAppData: Get the path inside \%LOCALAPPDATA\%
-\li #IsValidCodePage: Check whether given code page number is valid.
-\li #CopyFile: The UTF8 version of Win32 \c CopyFile.
-\li #MoveFile: The UTF8 version of Win32 \c MoveFile.
-\li #DeleteFile: The UTF8 version of Win32 \c DeleteFile.
-
-*/
-}

doc/src/windows/com.dox

@@ -0,0 +1,31 @@
+namespace yycc::windows::com {
+/**
+
+\page windows__com COM Helper
+
+This namespace is Windows specific.
+It will be invisible on other platforms.
+
+\section windows__com__memory_safe_ptr Memory Safe Pointer Types
+
+This namespace provides various memory-safe types for interacting with COM functions.
+Although Microsoft also has similar smart pointer called \c CComPtr.
+But this library is eager to hide all Microsoft-related functions calling.
+Using \c CComPtr is not corresponding with the philosophy of this library.
+So these standard library based smart pointer and corresponding deleter types were created.
+
+\section windows__com__com_guard COM Guard
+
+This namespace contains a COM Guard which make sure COM was initialized in current module when loading current module.
+It is essential because all calling to COM functions should be under the premise that COM has been initialized.
+This guard also will uninitialize COM when unloading this module.
+
+There is only an exposed function called is_initialized() for user calling.
+This function will check whether COM environment is initialized.
+If you want YYCC automatically initialize COM environment for you,
+you must call this function in your program at least one time.
+Otherwise COM Guard code may be unavailable,
+because compiler may think these code is not referenced by any other code and drop them.
+
+*/
+}

doc/src/windows/console.dox

@@ -0,0 +1,23 @@
+namespace yycc::windows::console {
+/**
+
+\page windows__console Windows Console Helper
+
+Namespace yycc::windows::console is designed to resolve some issue of Windows console
+which is not corresponding to POSIX system console.
+This namespace also is only available on Windows platform.
+
+Currently this namespace only has one function: colorful_console(),
+which enable colorful console output support for \c stdout and \c stderr in Windows.
+As we introduced, you may know Windows console does not support ASCII Escape Code color in default.
+This function can fix this issue.
+This function will forcely enable ASCII Escape Code support in Windows console if possible.
+Thus you can write colorful text in Windows console freely.
+We suggest you to call this function at the beginning of program.
+
+Considering most Linux console supports ASCII Escape Code very well,
+this function isn't presented in non-Windows platform.
+So it is essential that brack this function calling with Windows-only \c \#if.
+
+*/
+}

doc/src/windows/dialog.dox

@@ -1,7 +1,7 @@
-namespace YYCC::DialogHelper {
+namespace yycc::windows::dialog {
 /**
 
-\page dialog_helper Dialog Helper
+\page windows__dialog Dialog Helper
 
 Picking files and folders is an important and essential operation under Windows.
 However the functions picking files and folders are so complex.
@@ -11,7 +11,7 @@ In following contents we will tell you how to call them.
 This helper is Windows specific.
 It will be totally invisible if you are in other platforms.
 
-\section dialog_helper__file_dialog Configure File Dialog
+\section windows__dialog__file_dialog Configure File Dialog
 
 The first thing is that we should initialize FileDialog, 
 and configure it according to your requirements.
@@ -20,16 +20,16 @@ This class is the data struct representing all aspects of file dialog.
 It also one of the arguments in final dialog function.
 
 \code
-YYCC::DialogHelper::FileDialog params;
+FileDialog params;
-params.SetOwner(owner_getter());
+params.set_owner(owner_getter());
-params.SetTitle(YYCC_U8("My File Picker"));
+params.set_title(u8"My File Picker");
-params.SetInitFileName(YYCC_U8("test.txt"));
+params.set_init_file_name(u8"test.txt");
-params.SetInitDirectory(initial_directory_getter());
+params.set_init_directory(initial_directory_getter());
 \endcode
 
-\subsection dialog_helper__file_dialog__owner Owner
+\subsection windows__dialog__file_dialog__owner Owner
 
-FileDialog::SetOwner will set owner of this dialog.
+FileDialog::set_owner() will set owner of this dialog.
 It accepts a Microsoft defined \c HWND as argument which should be familiar with Windows programmer.
 If you pass \c NULL to it or skip calling this function, it indicate that there is no owner of this dialog.
 <I>
@@ -37,9 +37,9 @@ I don't what will happen if there is no owner for it.
 But it would be better to have an owner if possible.
 </I>
 
-\subsection dialog_helper__file_dialog__title Title
+\subsection windows__dialog__file_dialog__title Title
 
-FileDialog::SetTitle will set dialog title of this dialog.
+FileDialog::set_title() will set dialog title of this dialog.
 If you pass \c nullptr or skip calling it,
 the title of dialog will be filled by system and the function type you calling.
 For example, the title will be "Open..." if you call open file function,
@@ -48,9 +48,9 @@ At the same time, the language of this title filled by system is system UI depen
 It means that you do not need to do any extra I18N work for it.
 So I suggest you do not set title except you really want to modify title.
 
-\subsection dialog_helper__file_dialog__init_file_name Initial File Name
+\subsection windows__dialog__file_dialog__init_file_name Initial File Name
 
-FileDialog::SetInitFileName will set the initial file name presented in dialog file name input box.
+FileDialog::set_init_file_name() will set the initial file name presented in dialog file name input box.
 If you pass \c nullptr or skip calling it, the text in dialog file name input box will be empty.
 
 User can modify the name presented in input box later.
@@ -58,9 +58,9 @@ But if you assign this value, the dialog will lose the ability that remember the
 In normal case, dialog will try remembering the file name user input in dialog, and represent it in the next calling.
 However, if you specify this field, the dialog will always presented your specified value in every calling.
 
-\subsection dialog_helper__file_dialog__init_directory Initial Directory
+\subsection windows__dialog__file_dialog__init_directory Initial Directory
 
-FileDialog::SetInitDirectory will set the initial directory (startup directory) when opening dialog.
+FileDialog::set_init_directory() will set the initial directory (startup directory) when opening dialog.
 
 In following cases, initial directory will fall back to system behavior:
 
@@ -72,7 +72,7 @@ The system default behavior of initial directory is similar with initial file na
 The dialog will try remembering the last directory you just entering, and will back into it in the next calling.
 The directory we meeting in the first launch is system defined.
 
-\section dialog_helper__file_filters Configure File Filters
+\section windows__dialog__file_filters Configure File Filters
 
 File filters is a drop down list represented in file dialog which allow user filter files by their extensions.
 It is beneficial to let user get the file which they want in a directory including massive different files.
@@ -84,20 +84,20 @@ Directory can not be filtered.
 FileFilters takes responsibility for this feature:
 
 \code
-auto& filters = params.ConfigreFileTypes();
+auto& filters = params.configure_file_types();
-filters.Add(YYCC_U8("Microsoft Word (*.docx; *.doc)"), { YYCC_U8("*.docx"), YYCC_U8("*.doc") });
+filters.add_filter(u8"Microsoft Word (*.docx; *.doc)", { u8"*.docx", u8"*.doc" });
-filters.Add(YYCC_U8("Microsoft Excel (*.xlsx; *.xls)"), { YYCC_U8("*.xlsx"), YYCC_U8("*.xls") });
+filters.add_filter(u8"Microsoft Excel (*.xlsx; *.xls)", { u8"*.xlsx", u8"*.xls" });
-filters.Add(YYCC_U8("Microsoft PowerPoint (*.pptx; *.ppt)"), { YYCC_U8("*.pptx"), YYCC_U8("*.ppt") });
+filters.add_filter(u8"Microsoft PowerPoint (*.pptx; *.ppt)", { u8"*.pptx", u8"*.ppt" });
-filters.Add(YYCC_U8("Text File (*.txt)"), { YYCC_U8("*.txt") });
+filters.add_filter(u8"Text File (*.txt)", { u8"*.txt" });
-filters.Add(YYCC_U8("All Files (*.*)"), { YYCC_U8("*.*") });
+filters.add_filter(u8"All Files (*.*)", { u8"*.*" });
-params.SetDefaultFileTypeIndex(0u);
+params.set_default_file_type_index(0u);
 \endcode
 
-\subsection dialog_helper__file_filters__setup File Filters
+\subsection windows__dialog__file_filters__setup File Filters
 
 We don't need to initialize FileFilters by ourselves.
-Oppositely, we fetch it from FileDialog instance by calling FileDialog::ConfigreFileTypes.
+Oppositely, we fetch it from FileDialog instance by calling FileDialog::configure_file_types().
-After fetching, we can call FileFilters::Add to add a filter pair for file filters.
+After fetching, we can call FileFilters::add_filter() to add a filter pair for file filters.
 
 The first argument is the display text which user will see in file filter drop down box.
 
@@ -107,55 +107,51 @@ It is okey to use multiple wildcard string in list.
 This is suit for those file types involving multiple file extensions, such as the old and new file types of Microsoft Office as we illustracted.
 Empty list not allowed
 
-FileFilters::Add also will return a bool to indicate the success of this adding.
+FileFilters::add_filter() throws std::invalid_argument if filter name is blank or filter patterns is empty.
+Because these errors should be found during developing.
 
 It should at least has one file filter in file dialog.
 I don't know the consequence if you don't provide any file filter.
 
-\subsection dialog_helper__file_filters__default_filter Default File Type
+\subsection windows__dialog__file_filters__default_filter Default File Type
 
-FileDialog::SetDefaultFileTypeIndex will set the default selected file filter of this dialog.
+FileDialog::set_default_file_type_index() will set the default selected file filter of this dialog.
 It accepts an index pointing to the file filter which you want to show in default for this file dialog.
-The index of file filters is the order where you call FileFilters::Add above.
+The index of file filters is the order where you call FileFilters::add_filter() above.
 If you pass \c NULL to it or skip calling this function, the first one will be default.
 
-\section dialog_helper__result Create Dialog and Get Result
+\section windows__dialog__result Create Dialog and Get Result
 
 Finally, we can call file dialog functions by we initialized FileDialog
 
 \code
-YYCC::yycc_u8string single_selection;
+auto result1 = open_file(params);
-std::vector<YYCC::yycc_u8string> multiple_selection;
+auto result2 = open_files(params);
-
+auto result3 = save_file(params);
-YYCC::DialogHelper::OpenFileDialog(params, single_selection);
+auto result4 = open_folder(params);
-YYCC::DialogHelper::OpenMultipleFileDialog(params, multiple_selection);
-YYCC::DialogHelper::SaveFileDialog(params, single_selection);
-YYCC::DialogHelper::OpenFolderDialog(params, single_selection);
 \endcode
 
 There are 4 file dialogs you can choose:
 
-\li #OpenFileDialog:  Open single file
+\li open_file():  Open single file
-\li #OpenMultipleFileDialog: Open multiple files
+\li open_files(): Open multiple files
-\li #SaveFileDialog: Save single file
+\li save_file(): Save single file
-\li #OpenFolderDialog: Open single directory
+\li open_folder(): Open single directory
 
-\subsection dialog_helper__result__arguments Arguments
+\subsection windows__dialog__result__arguments Arguments
 
-Among these 4 functions, the first argument always is the reference to FileDialog.
+Among these 4 functions, the only argument is the reference to FileDialog.
-Function will use it to decide what should be shown in this file dialog.
+Function will use it to decide what would be shown in this file dialog.
 
-The second argument always is the reference to the container receiving the result.
+\subsection windows__dialog__result__return_value Return Value
-For single selection, the return type is \c yycc_u8string.
-For multiple selection, the return type is a list of strings: \c std::vector<yycc_u8string>.
 
-\subsection dialog_helper__result__return_value Return Value
+Please note these 4 functions will return a dialog specified result type as their return value.
+If this result type is an error, it means that an error occurred during execution.
+Otherwise, there is an optional value inside this result type.
+If user click Cancel button, this optional value will be empty.
+otherwise, this optional value will hold user selected a file or directory.
 
-Please note among these 4 functions will return a bool as its return value to indicate the success of function.
+\section windows__dialog__notes Notes
-If they return false, it means that the execution of functions are failed or user click Cancel button.
-In this case, there is no guaranteen to the content of second argument (the real return value).
-
-\section dialog_helper__notes Notes
 
 You may notice there are various classes which we never introduce.
 Because they are intermediate classes and should not be used by programmer.

doc/src/windows/import_guard.dox

@@ -1,25 +1,27 @@
-namespace YYCC {
+namespace yycc::windows {
 /**
 
-\page win_import Windows Import Guard
+\page windows__import_guard Windows Import Guard
 
 Windows is shitty for the programmer who is familiar with UNIX programming.
 Due to legacy reason, Windows defines various things which are not compatible with UNIX or standard C++ programming.
 
-\section win_import__usage Usage
+\section windows__import_guard__usage Usage
 
 YYCC has a way to solve the issue introduced above.
 
 \code
-#if YYCC_OS == YYCC_OS_WINDOWS
+#include <yycc/macro/os_detector.hpp>
-#include <WinImportPrefix.hpp>
+
+#if defined(YYCC_OS_WINDOWS)
+#include <yycc/windows/import_guard_head.hpp>
 #include <Windows.h>
 #include "other_header_depend_on_windows.h"
-#include <WinImportSuffix.hpp>
+#include <yycc/windows/import_guard_tail.hpp>
 #endif
 \endcode
 
-The including of WinImportPrefix.hpp and WinImportSuffix.hpp is a pair.
+The including of import_guard_head.hpp and import_guard_tail.hpp is a pair.
 They just like a guard bracket the include operation of Windows related headers,
 to keep all Windows shitty contents will not be leaked outside.
 
@@ -30,7 +32,7 @@ This guard can solve following issues:
     Programmer can not use \c std::max and \c std::min normally.
     <UL>
         <LI>Windows defines \c MAX and \c MIN as macros for personal use. This is why this happened.</LI>
-        <LI>Guard defines some special macros to tell Windows do not create these 2 macros.</LI>
+        <LI>This is actually resolved by CMake defined 2 public build macros which tell Windows do not create these 2 macros. But I simply conclude this feature in there.</LI>
     </UL>
     </LI>
     <LI>
@@ -44,12 +46,12 @@ This guard can solve following issues:
     Compiler throw annoy warnings and errors when using specific standard library functions.
     <UL>
         <LI>MSVC will throw warnings and errors when you are using Microsoft so-called \e depracted or \e unsafe standard library functions.</LI>
-        <LI>YYCCInternal.hpp, which has been included by this pair, defines some macros to purge these warnings and errors out.</LI>
+        <LI>This is also done by CMake public build macros.</LI>
     </UL>
     </LI>
 </UL>
 
-\section win_import__notes Notes
+\section windows__import_guard__notes Notes
 
 If you have other header files which are strongly depend on Windows header,
 you should put them into this bracket at the same time like example did.

doc/src/windows/winfct.dox

@@ -0,0 +1,15 @@
+namespace yycc::windows::winfct {
+/**
+
+\page windows__winfct Windows Function Helper
+
+Namespace yycc::windows::winfct gives a more convenient way to call Windows functions.
+If you want to know how to use these functions, please read the documentation of each function.
+The return value of most functions is a specific result type.
+If any error occurs, the result type will be an error, otherwise it will be the true result.
+
+This namespace is Windows specific.
+It will be entirely invisible in other platforms.
+
+*/
+}

script/.gitignore

@@ -1,2 +0,0 @@
-# -------------------- Output --------------------
-win_build.bat

script/gen_win_build.py

@@ -1,170 +0,0 @@
-import argparse
-import os
-import io
-import re
-
-def validate_cpp_ver(ver: str) -> str:
-    if re.match(r'^[0-9]+$', ver) is not None: return ver
-    else: raise argparse.ArgumentTypeError('invalid version of C++ standard.')
-
-def write_line(f: io.TextIOWrapper, val: str) -> None:
-    f.write(val)
-    f.write('\n')
-
-# Reference: https://stackoverflow.com/questions/29213106/how-to-securely-escape-command-line-arguments-for-the-cmd-exe-shell-on-windows
-def escape_argument(arg):
-    if not arg or re.search(r'(["\s])', arg):
-        arg = '"' + arg.replace('"', r'\"') + '"'
-    return escape_for_cmd_exe(arg)
-def escape_for_cmd_exe(arg):
-    meta_re = re.compile(r'([()%!^"<>&|])')
-    return meta_re.sub('^\1', arg)
-
-class ScriptSettings:
-    m_CppVersion: str
-    m_NoDoc: bool
-
-    def __init__(self, cpp_ver: str, no_doc: bool):
-        self.m_CppVersion = cpp_ver
-        self.m_NoDoc = no_doc
-
-def script_head(f: io.TextIOWrapper, s: ScriptSettings) -> None:
-    # change directory to root folder
-    write_line(f, ':: Navigate to project root directory')
-    root_dir: str = os.path.dirname(os.path.dirname(__file__))
-    write_line(f, f'CD /d {escape_argument(root_dir)}')
-    # create build directory and enter
-    write_line(f, ':: Create build directory and enter it')
-    write_line(f, 'MKDIR bin')
-    write_line(f, 'CD bin')
-    cpp_dir: str = f'cpp{s.m_CppVersion}'
-    write_line(f, f'MKDIR {cpp_dir}')
-    write_line(f, f'CD {cpp_dir}')
-    # blank line
-    write_line(f, '')
-
-def script_tail(f: io.TextIOWrapper, s: ScriptSettings) -> None:
-    # leave build directory and report success
-    write_line(f, ':: Leave build directory and report')
-    write_line(f, 'CD ..\\..')
-    write_line(f, 'ECHO Windows CMake Build Done')
-
-def create_directory(f: io.TextIOWrapper, s: ScriptSettings) -> None:
-    # create build directory
-    write_line(f, ':: Create internal build directory')
-    write_line(f, 'MKDIR Win32')
-    write_line(f, 'MKDIR x64')
-    write_line(f, 'MKDIR documentation')
-    # create install directory
-    write_line(f, ':: Create internal install directory')
-    write_line(f, 'MKDIR install')
-    write_line(f, 'CD install')
-    write_line(f, 'MKDIR Win32_Debug')
-    write_line(f, 'MKDIR Win32_Release')
-    write_line(f, 'MKDIR x64_Debug')
-    write_line(f, 'MKDIR x64_Release')
-    write_line(f, 'CD ..')
-    # create msvc install directory
-    write_line(f, ':: Create internal MSVC specific install directory')
-    write_line(f, 'MKDIR msvc_install')
-    write_line(f, 'CD msvc_install')
-    write_line(f, 'MKDIR bin')
-    write_line(f, 'MKDIR include')
-    write_line(f, 'MKDIR lib')
-    write_line(f, 'MKDIR share')
-    write_line(f, 'CD bin')
-    write_line(f, 'MKDIR Win32')
-    write_line(f, 'MKDIR x64')
-    write_line(f, 'CD ..')
-    write_line(f, 'CD lib')
-    write_line(f, 'MKDIR Win32\\Debug')
-    write_line(f, 'MKDIR Win32\\Release')
-    write_line(f, 'MKDIR x64\\Debug')
-    write_line(f, 'MKDIR x64\\Release')
-    write_line(f, 'CD ..')
-    write_line(f, 'CD ..')
-    # blank line
-    write_line(f, '')
-
-def cmake_build(f: io.TextIOWrapper, s: ScriptSettings) -> None:
-    # build for Win32
-    write_line(f, ':: Build for Win32')
-    write_line(f, 'CD Win32')
-    write_line(f, f'cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_CXX_STANDARD={s.m_CppVersion} -DYYCC_BUILD_TESTBENCH=ON ../../..')
-    write_line(f, 'cmake --build . --config Debug')
-    write_line(f, 'cmake --install . --prefix=../install/Win32_Debug --config Debug')
-    write_line(f, 'cmake --build . --config Release')
-    write_line(f, 'cmake --install . --prefix=../install/Win32_Release --config Release')
-    write_line(f, 'CD ..')
-    # build for x64
-    write_line(f, ':: Build for x64')
-    write_line(f, 'CD x64')
-    write_line(f, f'cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_CXX_STANDARD={s.m_CppVersion} -DYYCC_BUILD_TESTBENCH=ON ../../..')
-    write_line(f, 'cmake --build . --config Debug')
-    write_line(f, 'cmake --install . --prefix=../install/x64_Debug --config Debug')
-    write_line(f, 'cmake --build . --config Release')
-    write_line(f, 'cmake --install . --prefix=../install/x64_Release --config Release')
-    write_line(f, 'CD ..')
-    # build for documentation
-    if not s.m_NoDoc:
-        write_line(f, ':: Build for documentation')
-        write_line(f, 'CD documentation')
-        write_line(f, f'cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_CXX_STANDARD={s.m_CppVersion} -DYYCC_BUILD_DOC=ON ../../..')
-        write_line(f, 'cmake --build . --config Release')
-        write_line(f, 'cmake --build . --target YYCCDocumentation')
-        write_line(f, 'cmake --install . --prefix=../install/x64_Release --config Release')
-        write_line(f, 'CD ..')
-    # blank line
-    write_line(f, '')
-
-def msvc_build(f: io.TextIOWrapper, s: ScriptSettings) -> None:
-    # copy include from x64_Release build
-    write_line(f, ':: Copy header files')
-    write_line(f, 'XCOPY install\\x64_Release\\include msvc_install\\include\\ /E /Y')
-    # copy binary testbench
-    write_line(f, ':: Copy binary files')
-    write_line(f, 'COPY install\\Win32_Release\\bin\\YYCCTestbench.exe msvc_install\\bin\\Win32\\YYCCTestbench.exe /Y')
-    write_line(f, 'COPY install\\x64_Release\\bin\\YYCCTestbench.exe msvc_install\\bin\\x64\\YYCCTestbench.exe /Y')
-    # copy static library
-    write_line(f, ':: Copy library files')
-    write_line(f, 'COPY install\\Win32_Debug\\lib\\YYCCommonplace.lib msvc_install\\lib\\Win32\\Debug\\YYCCommonplace.lib /Y')
-    write_line(f, 'COPY install\\Win32_Release\\lib\\YYCCommonplace.lib msvc_install\\lib\\Win32\\Release\\YYCCommonplace.lib /Y')
-    write_line(f, 'COPY install\\x64_Debug\\lib\\YYCCommonplace.lib msvc_install\\lib\\x64\\Debug\\YYCCommonplace.lib /Y')
-    write_line(f, 'COPY install\\x64_Release\\lib\\YYCCommonplace.lib msvc_install\\lib\\x64\\Release\\YYCCommonplace.lib /Y')
-    # Copy document from x64_Release build
-    if not s.m_NoDoc:
-        write_line(f, ':: Copy documentation files')
-        write_line(f, 'XCOPY install\\x64_Release\\share msvc_install\\share\\ /E /Y')
-    # blank line
-    write_line(f, '')
-
-if __name__ == '__main__':
-    # parse argument
-    parser = argparse.ArgumentParser(
-        prog='YYCC Windows Build Script Generator',
-        description='YYCC Windows Build Script Generator'
-    )
-    parser.add_argument(
-        '-c', '--cpp',
-        action='store', default='17', dest='cpp', type=validate_cpp_ver,
-        help='The version of C++ standard used when building.'
-    )
-    parser.add_argument(
-        '-d', '--no-doc',
-        action='store_true', dest='no_doc',
-        help='Build YYCC without documentation.'
-    )
-    args = parser.parse_args()
-
-    # build settings
-    settings = ScriptSettings(args.cpp, args.no_doc)
-    # write result
-    filepath = os.path.join(os.path.dirname(__file__), 'win_build.bat')
-    with open(filepath, 'w') as f:
-        write_line(f, '@ECHO OFF')
-        script_head(f, settings)
-        create_directory(f, settings)
-        cmake_build(f, settings)
-        msvc_build(f, settings)
-        script_tail(f, settings)
-

script/linux_build.sh

@@ -1,32 +1,19 @@
 #!/bin/bash
-README_PATH=$(pwd)/README.md
+set -euo pipefail
-if [ ! -f "$README_PATH" ]; then
-    echo "Error: You must run this script at the root folder of this project!"
-    exit
-fi
 
-# Create main binary directory
+# Create build directory and enter it
 mkdir bin
 cd bin
-# Create build directory
+# Create internal build and install directory, then enter it
 mkdir build
-# Create install directory
 mkdir install
-cd install
-mkdir Debug
-mkdir Release
-cd ..
-
-# Build current system debug and release version
 cd build
-cmake -DCMAKE_BUILD_TYPE=Debug ../.. --fresh
-cmake --build .
-cmake --install . --prefix ../install/Debug
-cmake -DCMAKE_BUILD_TYPE=Release -DYYCC_BUILD_TESTBENCH=ON ../.. --fresh
-cmake --build .
-cmake --install . --prefix ../install/Release
-cd ..
 
-# Exit to original path
+# Build in Release mode
+cmake -DCMAKE_BUILD_TYPE=Release ../..
+cmake --build .
+cmake --install . --prefix=../install
+
+# Back to root directory
+cd ..
 cd ..
-echo "Linux CMake Build Done"

script/macos_build.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+set -euo pipefail
+
+# Create build directory and enter it
+mkdir bin
+cd bin
+# Create internal build and install directory, then enter it
+mkdir build
+mkdir install
+cd build
+
+# Build in Release mode
+cmake -DCMAKE_BUILD_TYPE=Release ../..
+cmake --build .
+cmake --install . --prefix=../install
+
+# Back to root directory
+cd ..
+cd ..

script/win_build.old.bat

@@ -1,57 +0,0 @@
-@ECHO OFF
-:: Check environment
-SET README_PATH=%CD%\README.md
-IF EXIST %README_PATH% (
-    REM DO NOTHING
-) ELSE (
-    ECHO Error: You must run this script at the root folder of this project!
-    EXIT /b
-)
-
-:: Create main binary directory
-MKDIR bin
-CD bin
-:: Create build folder
-MKDIR Win32
-MKDIR x64
-MKDIR documentation
-:: Create install folder
-MKDIR install
-CD install
-MKDIR Win32_Debug
-MKDIR Win32_Release
-MKDIR x64_Debug
-MKDIR x64_Release
-CD ..
-
-:: Build for Win32
-CD Win32
-cmake -G "Visual Studio 16 2019" -A Win32 -DYYCC_BUILD_TESTBENCH=ON ../..
-cmake --build . --config Debug
-cmake --install . --prefix=../install/Win32_Debug --config Debug
-cmake --build . --config Release
-cmake --install . --prefix=../install/Win32_Release --config Release
-CD ..
-
-:: Build for x64
-CD x64
-cmake -G "Visual Studio 16 2019" -A x64 -DYYCC_BUILD_TESTBENCH=ON ../..
-cmake --build . --config Debug
-cmake --install . --prefix=../install/x64_Debug --config Debug
-cmake --build . --config Release
-cmake --install . --prefix=../install/x64_Release --config Release
-CD ..
-
-:: Build for documentation
-IF NOT "%1"=="NODOC" (
-    CD documentation
-    cmake -G "Visual Studio 16 2019" -A x64 -DYYCC_BUILD_DOC=ON ../..
-    cmake --build . --config Release
-    cmake --build . --target YYCCDocumentation
-    cmake --install . --prefix=../install/x64_Release --config Release
-    CD ..
-)
-
-:: Exit to original path
-CD ..
-ECHO Windows CMake Build Done

script/win_msvc_build.old.bat

@@ -1,52 +0,0 @@
-@ECHO OFF
-SET README_PATH=%CD%\README.md
-IF EXIST %README_PATH% (
-    REM DO NOTHING
-) ELSE (
-    ECHO Error: You must run this script at the root folder of this project!
-    EXIT /b
-)
-
-:: Enter main binary directory
-CD bin
-
-:: Create MSVC binary directory
-MKDIR msvc_install
-CD msvc_install
-:: Create direcotries tree
-MKDIR bin
-MKDIR include
-MKDIR lib
-MKDIR share
-CD bin
-MKDIR Win32
-MKDIR x64
-CD ..
-CD lib
-MKDIR Win32\Debug
-MKDIR Win32\Release
-MKDIR x64\Debug
-MKDIR x64\Release
-CD ..
-:: Exit MSVC binary directory
-CD ..
-
-:: Copy result
-:: Copy include from x64_Release build
-XCOPY install\x64_Release\include msvc_install\include\ /E /Y
-:: Copy document from x64_Release build
-IF NOT "%1"=="NODOC" (
-    XCOPY install\x64_Release\share msvc_install\share\ /E /Y
-)
-:: Copy binary testbench
-COPY install\Win32_Release\bin\YYCCTestbench.exe msvc_install\bin\Win32\YYCCTestbench.exe /Y
-COPY install\x64_Release\bin\YYCCTestbench.exe msvc_install\bin\x64\YYCCTestbench.exe /Y
-:: Copy static library
-COPY install\Win32_Debug\lib\YYCCommonplace.lib msvc_install\lib\Win32\Debug\YYCCommonplace.lib /Y
-COPY install\Win32_Release\lib\YYCCommonplace.lib msvc_install\lib\Win32\Release\YYCCommonplace.lib /Y
-COPY install\x64_Debug\lib\YYCCommonplace.lib msvc_install\lib\x64\Debug\YYCCommonplace.lib /Y
-COPY install\x64_Release\lib\YYCCommonplace.lib msvc_install\lib\x64\Release\YYCCommonplace.lib /Y
-
-:: Exit to original path
-CD ..
-ECHO Windows MSVC Build Done

script/windows_build.bat

@@ -0,0 +1,18 @@
+@ECHO OFF
+
+:: Create build directory and enter it
+MKDIR bin
+CD bin
+:: Create internal build and install directory, then enter it
+MKDIR build
+MKDIR install
+CD build
+
+:: Build with x64 architecture in Release mode
+cmake -A x64 ../..
+cmake --build . --config Release
+cmake --install . --prefix=../install --config Release
+
+:: Back to root directory
+CD ..
+CD ..

src/ArgParser.cpp

@@ -1,348 +0,0 @@
-#include "ArgParser.hpp"
-
-#include "EncodingHelper.hpp"
-#include "ConsoleHelper.hpp"
-
-#if YYCC_OS == YYCC_OS_WINDOWS
-#include "WinImportPrefix.hpp"
-#include <Windows.h>
-#include <shellapi.h>
-#include <processenv.h>
-#include "WinImportSuffix.hpp"
-#endif
-
-namespace YYCC::ArgParser {
-
-#pragma region Arguments List
-
-	ArgumentList ArgumentList::CreateFromStd(int argc, char* argv[]) {
-		std::vector<yycc_u8string> args;
-		for (int i = 1; i < argc; ++i) { // starts with 1 to remove first part (executable self)
-			if (argv[i] != nullptr)
-				args.emplace_back(yycc_u8string(YYCC::EncodingHelper::ToUTF8(argv[i])));
-		}
-		return ArgumentList(std::move(args));
-	}
-
-#if YYCC_OS == YYCC_OS_WINDOWS
-	ArgumentList ArgumentList::CreateFromWin32() {
-		// Reference: https://learn.microsoft.com/en-us/windows/win32/api/shellapi/nf-shellapi-commandlinetoargvw
-
-		// prepare list
-		std::vector<yycc_u8string> args;
-
-		// try fetching from Win32 functions
-		int argc;
-		LPWSTR* argv = CommandLineToArgvW(GetCommandLineW(), &argc);
-		if (argv != NULL) {
-			for (int i = 1; i < argc; ++i) { // starts with 1 to remove first part (executable self)
-				if (argv[i] != nullptr) {
-					yycc_u8string u8_argv;
-					if (YYCC::EncodingHelper::WcharToUTF8(argv[i], u8_argv))
-						args.emplace_back(std::move(u8_argv));
-				}
-			}
-		}
-		LocalFree(argv);
-
-		// return result
-		return ArgumentList(std::move(args));
-	}
-#endif
-
-	ArgumentList::ArgumentList(std::vector<yycc_u8string>&& arguments) :
-		m_Arguments(arguments), m_ArgumentsCursor(0u) {}
-
-	void ArgumentList::Prev() {
-		if (m_ArgumentsCursor == 0u)
-			throw std::runtime_error("attempt to move on the head of iterator.");
-		--m_ArgumentsCursor;
-	}
-
-	void ArgumentList::Next() {
-		if (IsEOF()) throw std::runtime_error("attempt to move on the tail of iterator.");
-		++m_ArgumentsCursor;
-	}
-
-	const yycc_u8string& ArgumentList::Argument() const {
-		if (IsEOF()) throw std::runtime_error("attempt to get data on the tail of iterator.");
-		return m_Arguments[m_ArgumentsCursor];
-	}
-
-	bool ArgumentList::IsSwitch(bool* is_long_name, yycc_u8string* long_name, yycc_char8_t* short_name) const {
-		// check eof first
-		if (IsEOF()) throw std::runtime_error("attempt to fetch data on the tail of iterator.");
-		// check long name first, then check short name
-		if (IsLongNameSwitch(long_name)) {
-			if (is_long_name != nullptr) *is_long_name = true;
-			return true;
-		}
-		if (IsShortNameSwitch(short_name)) {
-			if (is_long_name != nullptr) *is_long_name = false;
-			return true;
-		}
-		// not matched
-		return false;
-	}
-	bool ArgumentList::IsLongNameSwitch(yycc_u8string* name_part) const {
-		// fetch current parameter
-		if (IsEOF()) throw std::runtime_error("attempt to fetch data on the tail of iterator.");
-		const yycc_u8string& param = m_Arguments[m_ArgumentsCursor];
-		// find double slash
-		if (param.find(AbstractArgument::DOUBLE_DASH) != 0u) return false;
-		// check gotten long name
-		yycc_u8string_view long_name = yycc_u8string_view(param).substr(2u);
-		if (!AbstractArgument::IsLegalLongName(long_name)) return false;
-		// set checked long name if possible and return
-		if (name_part != nullptr)
-			*name_part = long_name;
-		return true;
-	}
-	bool ArgumentList::IsShortNameSwitch(yycc_char8_t* name_part) const {
-		// fetch current parameter
-		if (IsEOF()) throw std::runtime_error("attempt to fetch data on the tail of iterator.");
-		const yycc_u8string& param = m_Arguments[m_ArgumentsCursor];
-		// if the length is not exactly equal to 2, 
-		// or it not starts with dash,
-		// it is impossible a short name
-		if (param.size() != 2u || param[0] != AbstractArgument::DASH) return false;
-		// check gotten short name
-		yycc_char8_t short_name = param[1];
-		if (!AbstractArgument::IsLegalShortName(short_name)) return false;
-		// set checked short name if possible and return
-		if (name_part != nullptr)
-			*name_part = short_name;
-		return true;
-	}
-
-	bool ArgumentList::IsValue(yycc_u8string* val) const {
-		bool is_value = !IsSwitch();
-		if (is_value && val != nullptr)
-			*val = m_Arguments[m_ArgumentsCursor];
-		return is_value;
-	}
-
-	bool ArgumentList::IsEOF() const { return m_ArgumentsCursor >= m_Arguments.size(); }
-
-	void ArgumentList::Reset() { m_ArgumentsCursor = 0u; }
-
-#pragma endregion
-
-#pragma region Abstract Argument
-
-	const yycc_u8string AbstractArgument::DOUBLE_DASH = YYCC_U8("--");
-	const yycc_char8_t AbstractArgument::DASH = YYCC_U8_CHAR('-');
-	const yycc_char8_t AbstractArgument::NO_SHORT_NAME = YYCC_U8_CHAR(0);
-	const yycc_char8_t AbstractArgument::MIN_SHORT_NAME = YYCC_U8_CHAR('!');
-	const yycc_char8_t AbstractArgument::MAX_SHORT_NAME = YYCC_U8_CHAR('~');
-
-	bool AbstractArgument::IsLegalShortName(yycc_char8_t short_name) {
-		if (short_name == AbstractArgument::DASH || // dash is not allowed
-			short_name < AbstractArgument::MIN_SHORT_NAME || short_name > AbstractArgument::MAX_SHORT_NAME) { // non-display ASCII chars are not allowed
-			return false;
-		}
-		// okey
-		return true;
-	}
-	bool AbstractArgument::IsLegalLongName(const yycc_u8string_view& long_name) {
-		// empty is not allowed
-		if (long_name.empty()) return false;
-		// non-display ASCII chars are not allowed
-		for (const auto& val : long_name) {
-			if (val < AbstractArgument::MIN_SHORT_NAME || val > AbstractArgument::MAX_SHORT_NAME)
-				return false;
-		}
-		// okey
-		return true;
-	}
-
-	AbstractArgument::AbstractArgument(
-		const yycc_char8_t* long_name, yycc_char8_t short_name,
-		const yycc_char8_t* description, const yycc_char8_t* argument_example,
-		bool is_optional) :
-		m_LongName(), m_ShortName(AbstractArgument::NO_SHORT_NAME), m_Description(), m_ArgumentExample(),
-		m_IsOptional(is_optional), m_IsCaptured(false) {
-
-		// try to assign long name and check it
-		if (long_name != nullptr) {
-			m_LongName = long_name;
-			if (!AbstractArgument::IsLegalLongName(m_LongName))
-				throw std::invalid_argument("Given long name is invalid.");
-		}
-		// try to assign short name and check it
-		if (short_name != AbstractArgument::NO_SHORT_NAME) {
-			m_ShortName = short_name;
-			if (!AbstractArgument::IsLegalShortName(m_ShortName))
-				throw std::invalid_argument("Given short name is invalid.");
-		}
-		// check short name and long name existence
-		if (!HasShortName() && !HasLongName())
-			throw std::invalid_argument("you must specify an one of long name or short name.");
-
-		// try to assign other string values
-		if (description != nullptr) m_Description = description;
-		if (argument_example != nullptr) m_ArgumentExample = argument_example;
-	}
-
-	AbstractArgument::~AbstractArgument() {}
-
-	bool AbstractArgument::HasLongName() const { return !m_LongName.empty(); }
-	const yycc_u8string& AbstractArgument::GetLongName() const { return m_LongName; }
-	bool AbstractArgument::HasShortName() const { return m_ShortName != NO_SHORT_NAME; }
-	yycc_char8_t AbstractArgument::GetShortName() const { return m_ShortName; }
-	bool AbstractArgument::HasDescription() const { return !m_Description.empty(); }
-	const yycc_u8string& AbstractArgument::GetDescription() const { return m_Description; }
-	bool AbstractArgument::HasArgumentExample() const { return !m_ArgumentExample.empty(); }
-	const yycc_u8string& AbstractArgument::GetArgumentExample() const { return m_ArgumentExample; }
-	bool AbstractArgument::IsOptional() const { return m_IsOptional; }
-
-	bool AbstractArgument::IsCaptured() const { return m_IsCaptured; }
-	void AbstractArgument::SetCaptured(bool is_captured) { m_IsCaptured = is_captured; }
-
-#pragma endregion
-
-#pragma region Option Context
-
-	OptionContext::OptionContext(
-		const yycc_char8_t* summary, const yycc_char8_t* description,
-		std::initializer_list<AbstractArgument*> arguments) :
-		m_Summary(), m_Description() {
-		// assign summary and description
-		if (summary != nullptr) m_Summary = summary;
-		if (description != nullptr) m_Description = description;
-
-		// insert argument list and check them
-		for (auto* arg : arguments) {
-			// insert into long name map if necessary
-			if (arg->HasLongName()) {
-				auto result = m_LongNameMap.try_emplace(arg->GetLongName(), arg);
-				if (!result.second) throw std::invalid_argument("duplicated long name!");
-			}
-			// insert into short name map if necessary
-			if (arg->HasShortName()) {
-				auto result = m_ShortNameMap.try_emplace(arg->GetShortName(), arg);
-				if (!result.second) throw std::invalid_argument("duplicated short name!");
-			}
-			// insert into argument list
-			m_Arguments.emplace_back(arg);
-		}
-	}
-
-	OptionContext::~OptionContext() {}
-
-	bool OptionContext::Parse(ArgumentList& al) {
-		// reset argument list first
-		al.Reset();
-
-		// prepare variables and start loop
-		yycc_u8string long_name;
-		yycc_char8_t short_name;
-		bool is_long_name;
-		while (!al.IsEOF()) {
-			// if we can not find any switches, return with error
-			if (!al.IsSwitch(&is_long_name, &long_name, &short_name)) return false;
-
-			// find corresponding argument by long name or short name.
-			// if we can not find it, return with error.
-			AbstractArgument* arg;
-			if (is_long_name) {
-				auto finder = m_LongNameMap.find(long_name);
-				if (finder == m_LongNameMap.end()) return false;
-				arg = finder->second;
-			} else {
-				auto finder = m_ShortNameMap.find(short_name);
-				if (finder == m_ShortNameMap.end()) return false;
-				arg = finder->second;
-			}
-
-			// if this argument has been captured, raise error
-			if (arg->IsCaptured()) return false;
-			// call user parse function of found argument
-			if (arg->Parse(al)) {
-				// success. mark it is captured
-				arg->SetCaptured(true);
-			} else {
-				// failed, return error
-				return false;
-			}
-
-			// move to next argument
-			al.Next();
-		}
-
-		// after processing all argument,
-		// we should check whether all non-optional argument are captured.
-		for (const auto* arg : m_Arguments) {
-			if (!arg->IsOptional() && !arg->IsCaptured())
-				return false;
-		}
-
-		// okey
-		return true;
-	}
-
-	void OptionContext::Reset() {
-		for (auto* arg : m_Arguments) {
-			// clear user data and unset captured
-			arg->Reset();
-			arg->SetCaptured(false);
-		}
-	}
-
-	void OptionContext::Help() const {
-		// print summary and description if necessary
-		if (!m_Summary.empty())
-			YYCC::ConsoleHelper::WriteLine(m_Summary.c_str());
-		if (!m_Description.empty())
-			YYCC::ConsoleHelper::WriteLine(m_Description.c_str());
-
-		// blank line
-		YYCC::ConsoleHelper::WriteLine(YYCC_U8(""));
-
-		// print argument list
-		for (const auto* arg : m_Arguments) {
-			yycc_u8string argstr;
-
-			// print indent
-			argstr += YYCC_U8("\t");
-			// print optional head
-			bool is_optional = arg->IsOptional();
-			if (is_optional) argstr += YYCC_U8("[");
-
-			// switch name
-			bool short_name = arg->HasShortName(), long_name = arg->HasLongName();
-			if (short_name) {
-				argstr += YYCC_U8("-");
-				argstr += arg->GetShortName();
-			}
-			if (long_name) {
-				if (short_name) argstr += YYCC_U8(", ");
-				argstr += YYCC_U8("--");
-				argstr += arg->GetLongName();
-			}
-
-			// argument example
-			if (arg->HasArgumentExample()) {
-				argstr += YYCC_U8(" ");
-				argstr += arg->GetArgumentExample();
-			}
-
-			// optional tail
-			if (is_optional) argstr += YYCC_U8("]");
-
-			// argument description
-			if (arg->HasDescription()) {
-				// eol and double indent
-				argstr += YYCC_U8("\n\t\t");
-				// description
-				argstr += arg->GetDescription();
-			}
-
-			// write into console
-			YYCC::ConsoleHelper::WriteLine(argstr.c_str());
-		}
-	}
-
-#pragma endregion
-
-}

src/ArgParser.hpp

@@ -1,464 +0,0 @@
-#pragma once
-#include "YYCCInternal.hpp"
-
-#include "Constraints.hpp"
-#include "EncodingHelper.hpp"
-#include "ParserHelper.hpp"
-#include <functional>
-#include <vector>
-#include <map>
-#include <stdexcept>
-
-/**
- * @brief Universal argument parser.
- * @details
- * For how to use this namespace, please see \ref arg_parser.
-*/
-namespace YYCC::ArgParser {
-
-	/**
-	 * @brief The advanced wrapper of the list containing command line arguments.
-	 * @details
-	 * This class is used by OptionContext and argument class internally for convenience.
-	 * It should not be constrcuted directly.
-	 * Programmer should choose proper static creation function to create instance of this class.
-	*/
-	class ArgumentList {
-	public:
-		/**
-		 * @brief Create argument list from the parameters of standard C main function.
-		 * @param[in] argc The argument count passed to standard C main function.
-		 * @param[in] argv The argument value passed to standard C main function.
-		 * @return Extracted argument list instance.
-		 * @remarks
-		 * First item in command line will be stripped,
-		 * because in most cases it points to executable self
-		 * and should not be seen as a part of arguments.
-		*/
-		static ArgumentList CreateFromStd(int argc, char* argv[]);
-#if YYCC_OS == YYCC_OS_WINDOWS
-		/**
-		 * @brief Create argument list from Win32 function.
-		 * @details
-		 * @return Extracted argument list instance.
-		 * @remarks
-		 * First item in command line will be stripped,
-		 * because in most cases it points to executable self
-		 * and should not be seen as a part of arguments.
-		 * \par
-		 * Programmer should use this function instead of CreateFromStd(),
-		 * because that function involve encoding issue on Windows, especially command line including non-ASCII chars.
-		 * Only this function guaranteen that return correct argument list on Windows.
-		*/
-		static ArgumentList CreateFromWin32();
-#endif
-	private:
-		/**
-		 * @brief Constructor of ArgumentList used internally.
-		 * @param[in] arguments
-		 * Underlying argument list.
-		 * This argument list should remove first executable name before passing it to there.
-		*/
-		ArgumentList(std::vector<yycc_u8string>&& arguments);
-	public:
-		YYCC_DEF_CLS_COPY_MOVE(ArgumentList);
-
-	public:
-		/**
-		 * @brief Move to previous argument.
-		 * @exception std::runtime_error Try moving at the head of argument list.
-		*/
-		void Prev();
-		/**
-		 * @brief Move to next argument.
-		 * @exception std::runtime_error Try moving at the tail of argument list.
-		*/
-		void Next();
-		/**
-		 * @brief Get the string of current argument.
-		 * @exception std::runtime_error Try fetching data at the tail of argument list.
-		 * @return The constant reference to the string of current argument.
-		*/
-		const yycc_u8string& Argument() const;
-		/**
-		 * @brief Check whether current argument is a option / switch.
-		 * @param[out] is_long_name
-		 * It will be set true if this argument is long name, otherwise short name.
-		 * nullptr if you don't want to receive this infomation.
-		 * @param[out] long_name
-		 * The container holding matched long name if it is (double dash stripped).
-		 * nullptr if you don't want to receive this infomation.
-		 * @param[out] short_name
-		 * The variable holding matched short name if it is (dash stripped).
-		 * nullptr if you don't want to receive this infomation.
-		 * @exception std::runtime_error Try fetching data at the tail of argument list.
-		 * @return
-		 * True if it is, otherwise false.
-		 * If this function return false, all given parameters are in undefined status.
-		*/
-		bool IsSwitch(
-			bool* is_long_name = nullptr,
-			yycc_u8string* long_name = nullptr,
-			yycc_char8_t* short_name = nullptr) const;
-		/**
-		 * @brief Check whether current argument is a value.
-		 * @param[out] val
-		 * The variable holding value if it is.
-		 * nullptr if you don't want to receive this infomation.
-		 * @exception std::runtime_error Try fetching data at the tail of argument list.
-		 * @return True if it is, otherwise false.
-		*/
-		bool IsValue(yycc_u8string* val = nullptr) const;
-		/**
-		 * @brief Check whether we are at the tail of argument list.
-		 * @details
-		 * Please note EOF is a special state that you can not fetch data from it.
-		 * EOF is the next element of the last element of argument list.
-		 * It more like \c end() in most C++ container.
-		 * @return True if it is, otherwise false.
-		*/
-		bool IsEOF() const;
-		/**
-		 * @brief Reset cursor to the head of argument list for reuse.
-		*/
-		void Reset();
-	private:
-		/**
-		 * @brief Check whether current argument is long name option / switch.
-		 * @details This function is used by IsSwitch() internally.
-		 * @param[out] name_part
-		 * The container holding matched long name if it is (double dash stripped).
-		 * nullptr if you don't want to receive this infomation.
-		 * @return True if it is, otherwise false.
-		*/
-		bool IsLongNameSwitch(yycc_u8string* name_part = nullptr) const;
-		/**
-		 * @brief Check whether current argument is short name option / switch.
-		 * @details This function is used by IsSwitch() internally.
-		 * @param[out] name_part
-		 * The variable holding matched short name if it is (dash stripped).
-		 * nullptr if you don't want to receive this infomation.
-		 * @return True if it is, otherwise false.
-		*/
-		bool IsShortNameSwitch(yycc_char8_t* name_part = nullptr) const;
-
-	private:
-		std::vector<yycc_u8string> m_Arguments;
-		size_t m_ArgumentsCursor;
-	};
-
-	/**
-	 * @brief The base class of every argument.
-	 * @details Programmer can inherit this class and implement essential functions to create custom argument.
-	*/
-	class AbstractArgument {
-		friend class OptionContext;
-
-		// Long name and short name constants and checker.
-	public:
-		static const yycc_u8string DOUBLE_DASH; ///< The constant value representing double dash (\c --)
-		static const yycc_char8_t DASH; ///< The constant value representing dash (\c -)
-		static const yycc_char8_t NO_SHORT_NAME; ///< The constant value representing that there is not short value.
-		static const yycc_char8_t MIN_SHORT_NAME; ///< The constant value representing the minimum value of valid ASCII chars in short and long name.
-		static const yycc_char8_t MAX_SHORT_NAME; ///< The constant value representing the maximum value of valid ASCII chars in short and long name.
-		/**
-		 * @brief Check whether given short name is valid.
-		 * @details
-		 * An ASCII code of valid short name
-		 * should not lower than #MIN_SHORT_NAME or higher than #MAX_SHORT_NAME.
-		 * It also can not be #DASH.
-		 * @param[in] short_name Short name for checking.
-		 * @return True if it is valid, otherwise false.
-		*/
-		static bool IsLegalShortName(yycc_char8_t short_name);
-		/**
-		 * @brief Check whether given long name is valid.
-		 * @details
-		 * An ASCII code of every item in valid long name
-		 * should not lower than #MIN_SHORT_NAME or higher than #MAX_SHORT_NAME.
-		 * However it can be #DASH. This is different with short name.
-		 * @param[in] long_name Long name for checking.
-		 * @return True if it is valid, otherwise false.
-		*/
-		static bool IsLegalLongName(const yycc_u8string_view& long_name);
-
-		// Constructor & destructor
-	public:
-		/**
-		 * @brief Constructor an argument
-		 * @param[in] long_name The long name of this argument. nullptr if no long name.
-		 * @param[in] short_name The short name of this argument. #NO_SHORT_NAME if no short name.
-		 * @param[in] description The description of this argument to indroduce what this argument does. nullptr if no description.
-		 * @param[in] argument_example The example string of this argument's value. nullptr if no example.
-		 * @param[in] is_optional
-		 * True if this argument is optional argument.
-		 * Optional argument can be absent in argument list.
-		 * Non-optional argument must be presented in argument list,
-		 * otherwise parser will fail.
-		 * @exception std::invalid_argument Given short name or long name are invalid.
-		*/
-		AbstractArgument(
-			const yycc_char8_t* long_name, yycc_char8_t short_name = AbstractArgument::NO_SHORT_NAME,
-			const yycc_char8_t* description = nullptr, const yycc_char8_t* argument_example = nullptr,
-			bool is_optional = false);
-		virtual ~AbstractArgument();
-		YYCC_DEL_CLS_COPY_MOVE(AbstractArgument);
-
-		// ===== User Implementation =====
-	protected:
-		/**
-		 * @brief User implemented custom parse function
-		 * @param[in] al  The argument list for parsing.
-		 * @return True if parse is success, otherwise false.
-		 * @remarks
-		 * When enter this function, argument list points to switch self.
-		 * After success parsing, you should point it to the argument this function last accepted.
-		 * For exmaple, for command line "-i 114514",
-		 * when enter this function, this argument list point to "-i",
-		 * and you should set it to "114514" when exiting this function.
-		*/
-		virtual bool Parse(ArgumentList& al) = 0;
-		/**
-		 * @brief User implemented custom reset function
-		 * @remarks
-		 * In this function, user should claer its stored value if is has.
-		 * You don't need clar capture state. That is done by library self.
-		*/
-		virtual void Reset() = 0;
-
-		// ===== Basic Infos =====
-	public:
-		/// @brief Check whether this argument specify long name.
-		/// @return True if it is, otherwise false.
-		bool HasLongName() const;
-		/// @brief Get specified long name.
-		/// @return Specified long name.
-		const yycc_u8string& GetLongName() const;
-		/// @brief Check whether this argument specify short name.
-		/// @return True if it is, otherwise false.
-		bool HasShortName() const;
-		/// @brief Get specified short name.
-		/// @return Specified short name.
-		yycc_char8_t GetShortName() const;
-		/// @brief Check whether this argument specify description.
-		/// @return True if it is, otherwise false.
-		bool HasDescription() const;
-		/// @brief Get specified description.
-		/// @return Specified description.
-		const yycc_u8string& GetDescription() const;
-		/// @brief Check whether this argument specify example.
-		/// @return True if it is, otherwise false.
-		bool HasArgumentExample() const;
-		/// @brief Get specified example.
-		/// @return Specified example.
-		const yycc_u8string& GetArgumentExample() const;
-		/// @brief Check whether this argument is optional.
-		/// @return True if it is, otherwise false.
-		bool IsOptional() const;
-	private:
-		yycc_u8string m_LongName;
-		yycc_char8_t m_ShortName;
-		yycc_u8string m_Description;
-		yycc_u8string m_ArgumentExample;
-		bool m_IsOptional;
-
-		// ===== Capture State =====
-	public:
-		/// @brief Check whether this argument has been captured.
-		/// @return True if it is, otherwise false.
-		bool IsCaptured() const;
-	private:
-		/**
-		 * @brief Set capture state of this argument.
-		 * @details This function is used internally by OptionContext.
-		 * @param[in] is_captured New states of captured.
-		*/
-		void SetCaptured(bool is_captured);
-		bool m_IsCaptured;
-	};
-
-	/// @brief The core of argument parser, also manage all arguments.
-	class OptionContext {
-	public:
-		/**
-		 * @brief Construct option context.
-		 * @param[in] summary The summary of this application which will be printed in help text.
-		 * @param[in] description The description of this application which will be printed in help text.
-		 * @param[in] arguments The initializer list including pointers to all arguments.
-		*/
-		OptionContext(
-			const yycc_char8_t* summary, const yycc_char8_t* description,
-			std::initializer_list<AbstractArgument*> arguments);
-		~OptionContext();
-		YYCC_DEL_CLS_COPY_MOVE(OptionContext);
-
-	public:
-		/**
-		 * @brief Start a parse.
-		 * @param[in] al The reference to ArgumentList for parsing.
-		 * @return
-		 * True if success, otherwise false.
-		 * If this function return false, you should not visit any arguments it managed.
-		*/
-		bool Parse(ArgumentList& al);
-		/**
-		 * @brief Reset all managed argument to default state thus you can start another parsing.
-		*/
-		void Reset();
-		/**
-		 * @brief Print help text in \c stdout.
-		*/
-		void Help() const;
-
-	private:
-		yycc_u8string m_Summary;
-		yycc_u8string m_Description;
-
-		std::vector<AbstractArgument*> m_Arguments;
-		std::map<yycc_u8string, AbstractArgument*> m_LongNameMap;
-		std::map<yycc_char8_t, AbstractArgument*> m_ShortNameMap;
-	};
-
-#pragma region Argument Presets
-
-	/**
-	 * @brief Arithmetic (integral, floating point. except bool) type argument
-	 * @tparam _Ty The internal stored type belongs to arithmetic type.
-	*/
-	template<typename _Ty, std::enable_if_t<std::is_arithmetic_v<_Ty> && !std::is_same_v<_Ty, bool>, int> = 0>
-	class NumberArgument : public AbstractArgument {
-	public:
-		/**
-		 * @brief Constructor an arithmetic argument
-		 * @param[in] long_name The long name of this argument. nullptr if no long name.
-		 * @param[in] short_name The short name of this argument. #NO_SHORT_NAME if no short name.
-		 * @param[in] description The description of this argument to indroduce what this argument does. nullptr if no description.
-		 * @param[in] argument_example The example string of this argument's value. nullptr if no example.
-		 * @param[in] is_optional True if this argument is optional argument.
-		 * @param[in] constraint The constraint applied to this argument.
-		 * @exception std::invalid_argument Given short name or long name are invalid.
-		*/
-		NumberArgument(
-			const yycc_char8_t* long_name, yycc_char8_t short_name,
-			const yycc_char8_t* description = nullptr, const yycc_char8_t* argument_example = nullptr,
-			bool is_optional = false,
-			Constraints::Constraint<_Ty> constraint = Constraints::Constraint<_Ty> {}) :
-			AbstractArgument(long_name, short_name, description, argument_example, is_optional), m_Data(), m_Constraint(constraint) {}
-		virtual ~NumberArgument() {}
-		YYCC_DEL_CLS_COPY_MOVE(NumberArgument);
-
-	public:
-		/// @brief Get stored data in argument.
-		_Ty Get() const {
-			if (!IsCaptured()) throw std::runtime_error("try fetching data from a not captured argument.");
-			return m_Data;
-		}
-
-	protected:
-		virtual bool Parse(ArgumentList& al) override {
-			// try get corresponding value
-			yycc_u8string strval;
-			al.Next();
-			if (al.IsEOF() || !al.IsValue(&strval)) {
-				al.Prev();
-				return false;
-			}
-			// try parsing value
-			if (!YYCC::ParserHelper::TryParse<_Ty>(strval, m_Data)) return false;
-			// check constraint
-			if (m_Constraint.IsValid() && !m_Constraint.m_CheckFct(m_Data))
-				return false;
-			// okey
-			return true;
-		}
-		virtual void Reset() override {
-			std::memset(&m_Data, 0, sizeof(m_Data));
-		}
-
-	protected:
-		_Ty m_Data;
-		Constraints::Constraint<_Ty> m_Constraint;
-	};
-
-	/**
-	 * @brief A simple switch type argument which do not store any value.
-	*/
-	class SwitchArgument : public AbstractArgument {
-	public:
-		/**
-		 * @brief Constructor an switch argument
-		 * @param[in] long_name The long name of this argument. nullptr if no long name.
-		 * @param[in] short_name The short name of this argument. #NO_SHORT_NAME if no short name.
-		 * @param[in] description The description of this argument to indroduce what this argument does. nullptr if no description.
-		 * @exception std::invalid_argument Given short name or long name are invalid.
-		*/
-		SwitchArgument(
-			const yycc_char8_t* long_name, yycc_char8_t short_name,
-			const yycc_char8_t* description = nullptr) :
-			// bool switch must be optional, because it is false if no given switch.
-			// bool switch doesn't have argument, so it doesn't have example property.
-			AbstractArgument(long_name, short_name, description, nullptr, true) {}
-		virtual ~SwitchArgument() {}
-		YYCC_DEL_CLS_COPY_MOVE(SwitchArgument);
-
-	protected:
-		virtual bool Parse(ArgumentList& al) override { return true; } // simply return true because no value to store.
-		virtual void Reset() override {} // nothing need to be reset.
-	};
-
-	/// @brief String type argument
-	class StringArgument : public AbstractArgument {
-	public:
-		/**
-		 * @brief Constructor a string argument
-		 * @param[in] long_name The long name of this argument. nullptr if no long name.
-		 * @param[in] short_name The short name of this argument. #NO_SHORT_NAME if no short name.
-		 * @param[in] description The description of this argument to indroduce what this argument does. nullptr if no description.
-		 * @param[in] argument_example The example string of this argument's value. nullptr if no example.
-		 * @param[in] is_optional True if this argument is optional argument.
-		 * @param[in] constraint The constraint applied to this argument.
-		 * @exception std::invalid_argument Given short name or long name are invalid.
-		*/
-		StringArgument(
-			const yycc_char8_t* long_name, yycc_char8_t short_name,
-			const yycc_char8_t* description = nullptr, const yycc_char8_t* argument_example = nullptr,
-			bool is_optional = false,
-			Constraints::Constraint<yycc_u8string> constraint = Constraints::Constraint<yycc_u8string> {}) :
-			AbstractArgument(long_name, short_name, description, argument_example, is_optional), m_Data(), m_Constraint(constraint) {}
-		virtual ~StringArgument() {}
-		YYCC_DEL_CLS_COPY_MOVE(StringArgument);
-
-	public:
-		/// @brief Get stored data in argument.
-		const yycc_u8string& Get() const {
-			if (!IsCaptured()) throw std::runtime_error("try fetching data from a not captured argument.");
-			return m_Data;
-		}
-
-	protected:
-		virtual bool Parse(ArgumentList& al) override {
-			// try get corresponding value
-			al.Next();
-			if (al.IsEOF() || !al.IsValue(&m_Data)) {
-				al.Prev();
-				return false;
-			}
-			// check constraint
-			if (m_Constraint.IsValid() && !m_Constraint.m_CheckFct(m_Data))
-				return false;
-			// okey
-			return true;
-		}
-		virtual void Reset() override {
-			m_Data.clear();
-		}
-
-	protected:
-		yycc_u8string m_Data;
-		Constraints::Constraint<yycc_u8string> m_Constraint;
-	};
-
-#pragma endregion
-
-
-}

src/CMakeLists.txt

@@ -1,48 +1,120 @@
+# Configure version file
+configure_file(
+    ${CMAKE_CURRENT_LIST_DIR}/yycc/version.hpp.in
+    ${CMAKE_CURRENT_LIST_DIR}/yycc/version.hpp
+    @ONLY
+)
+
 # Create static library
 add_library(YYCCommonplace STATIC "")
 # Setup static library sources
 target_sources(YYCCommonplace
 PRIVATE
     # Sources
-    COMHelper.cpp
+    yycc/string/reinterpret.cpp
-    ArgParser.cpp
+    yycc/string/op.cpp
-    ConfigManager.cpp
+    yycc/patch/fopen.cpp
-    ConsoleHelper.cpp
+    yycc/patch/stream.cpp
-    DialogHelper.cpp
+    yycc/panic.cpp
-    EncodingHelper.cpp
+    yycc/env.cpp
-    ExceptionHelper.cpp
+    yycc/windows/com.cpp
-    StdPatch.cpp
+    yycc/windows/dialog.cpp
-    IOHelper.cpp
+    yycc/windows/winfct.cpp
-    StringHelper.cpp
+    yycc/windows/console.cpp
-    WinFctHelper.cpp
+    yycc/encoding/stl.cpp
-    # Natvis (only for MSVC)
+    yycc/encoding/windows.cpp
-    $<$<CXX_COMPILER_ID:MSVC>:YYCC.natvis>
+    yycc/encoding/iconv.cpp
+
+    yycc/carton/pycodec.cpp
+    yycc/carton/termcolor.cpp
+    yycc/carton/wcwidth.cpp
+    yycc/carton/tabulate.cpp
+    yycc/carton/ironpad.cpp
+    yycc/carton/csconsole.cpp
+    yycc/carton/clap/option.cpp
+    yycc/carton/clap/variable.cpp
+    yycc/carton/clap/summary.cpp
+    yycc/carton/clap/application.cpp
+    yycc/carton/clap/manual.cpp
+    yycc/carton/clap/parser.cpp
+    yycc/carton/clap/resolver.cpp
+    yycc/carton/binstore/types.cpp
+    yycc/carton/binstore/setting.cpp
+    yycc/carton/binstore/configuration.cpp
+    yycc/carton/binstore/storage.cpp
+    yycc/carton/lexer61.cpp
 )
 target_sources(YYCCommonplace 
 PUBLIC
 FILE_SET HEADERS
 FILES
     # Headers
-    # Common headers
+    yycc.hpp
-    Constraints.hpp
+    yycc/version.hpp
-    COMHelper.hpp
+    yycc/macro/version_cmp.hpp
-    ArgParser.hpp
+    yycc/macro/os_detector.hpp
-    ConfigManager.hpp
+    yycc/macro/stl_detector.hpp
-    ConsoleHelper.hpp
+    yycc/macro/endian_detector.hpp
-    DialogHelper.hpp
+    yycc/macro/compiler_detector.hpp
-    EncodingHelper.hpp
+    yycc/macro/ptr_size_detector.hpp
-    ExceptionHelper.hpp
+    yycc/macro/class_copy_move.hpp
-    StdPatch.hpp
+    yycc/macro/printf_checker.hpp
-    IOHelper.hpp
+    yycc/cenum.hpp
-    ParserHelper.hpp
+    yycc/string.hpp
-    StringHelper.hpp
+    yycc/string/reinterpret.hpp
-    WinFctHelper.hpp
+    yycc/string/op.hpp
-    # Windows including guard pair
+    yycc/patch/ptr_pad.hpp
-    WinImportPrefix.hpp
+    yycc/patch/fopen.hpp
-    WinImportSuffix.hpp
+    yycc/patch/stream.hpp
-    # Misc
+    yycc/patch/format.hpp
-    YYCCInternal.hpp
+    yycc/patch/libcxx/enumerate.hpp
-    YYCCommonplace.hpp
+    yycc/patch/libcxx/stacktrace.hpp
+    yycc/patch/libcxx/charconv.hpp
+    yycc/num/parse.hpp
+    yycc/num/stringify.hpp
+    yycc/num/safe_cast.hpp
+    yycc/num/safe_op.hpp
+    yycc/num/op.hpp
+    yycc/primitive.hpp
+    yycc/option.hpp
+    yycc/result.hpp
+    yycc/prelude.hpp
+    yycc/panic.hpp
+    yycc/env.hpp
+    yycc/windows/import_guard_head.hpp
+    yycc/windows/import_guard_tail.hpp
+    yycc/windows/com.hpp
+    yycc/windows/dialog.hpp
+    yycc/windows/winfct.hpp
+    yycc/windows/console.hpp
+    yycc/encoding/stl.hpp
+    yycc/encoding/windows.hpp
+    yycc/encoding/iconv.hpp
+
+    yycc/carton/pycodec.hpp
+    yycc/carton/termcolor.hpp
+    yycc/carton/wcwidth.hpp
+    yycc/carton/tabulate.hpp
+    yycc/carton/ironpad.hpp
+    yycc/carton/csconsole.hpp
+    yycc/carton/clap.hpp
+    yycc/carton/clap/types.hpp
+    yycc/carton/clap/option.hpp
+    yycc/carton/clap/variable.hpp
+    yycc/carton/clap/summary.hpp
+    yycc/carton/clap/application.hpp
+    yycc/carton/clap/manual.hpp
+    yycc/carton/clap/validator.hpp
+    yycc/carton/clap/parser.hpp
+    yycc/carton/clap/resolver.hpp
+    yycc/carton/binstore.hpp
+    yycc/carton/binstore/types.hpp
+    yycc/carton/binstore/serdes.hpp
+    yycc/carton/binstore/setting.hpp
+    yycc/carton/binstore/configuration.hpp
+    yycc/carton/binstore/storage.hpp
+    yycc/carton/lexer61.hpp
+    yycc/carton/fft.hpp
 )
 # Setup header infomations
 target_include_directories(YYCCommonplace
@@ -50,30 +122,80 @@ PUBLIC
     "$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}>"
     "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>"
 )
+# Link Iconv if we have import it
+if (Iconv_FOUND)
+    target_link_libraries(YYCCommonplace
+        PRIVATE
+            Iconv::Iconv
+    )
+endif ()
 # Link with DbgHelp.lib on Windows
 target_link_libraries(YYCCommonplace
 PRIVATE
     $<$<BOOL:${WIN32}>:DbgHelp.lib>
 )
-# Setup C++ standard
-target_compile_features(YYCCommonplace PUBLIC cxx_std_17)
-set_target_properties(YYCCommonplace PROPERTIES CXX_EXTENSION OFF)
 # Setup macros
 target_compile_definitions(YYCCommonplace
-# Debug macro should populate to child projects
 PUBLIC
-    $<$<BOOL:${YYCC_DEBUG_UE_FILTER}>:YYCC_DEBUG_UE_FILTER>
+    # Iconv environment macro
-# Unicode charset for private using
+    $<$<BOOL:${Iconv_FOUND}>:YYCC_FEAT_ICONV>
-PRIVATE
+    # OS macro
+    $<$<PLATFORM_ID:Windows>:YYCC_OS_WINDOWS>
+    $<$<PLATFORM_ID:Linux>:YYCC_OS_LINUX>
+    $<$<PLATFORM_ID:Android>:YYCC_OS_LINUX> # We brutally think Android as Linux.
+    $<$<PLATFORM_ID:Darwin>:YYCC_OS_MACOS>
+    $<$<PLATFORM_ID:iOS>:YYCC_OS_MACOS> # We brutally think iOS as macOS.
+    # Compiler macro
+    $<$<CXX_COMPILER_ID:MSVC>:YYCC_CC_MSVC>
+    $<$<CXX_COMPILER_ID:GNU>:YYCC_CC_GCC>
+    $<$<CXX_COMPILER_ID:Clang>:YYCC_CC_CLANG>
+    $<$<CXX_COMPILER_ID:AppleClang>:YYCC_CC_CLANG> # We brutally think AppleClang is Clang.
+    # Endian macro
+    $<$<STREQUAL:${CMAKE_CXX_BYTE_ORDER},LITTLE_ENDIAN>:YYCC_ENDIAN_LITTLE>
+    $<$<STREQUAL:${CMAKE_CXX_BYTE_ORDER},BIG_ENDIAN>:YYCC_ENDIAN_BIG>
+    # Pointer size macro
+    $<$<EQUAL:${CMAKE_SIZEOF_VOID_P},4>:YYCC_PTRSIZE_32>
+    $<$<EQUAL:${CMAKE_SIZEOF_VOID_P},8>:YYCC_PTRSIZE_64>
+    # Use Unicode charset on MSVC
     $<$<CXX_COMPILER_ID:MSVC>:UNICODE>
     $<$<CXX_COMPILER_ID:MSVC>:_UNICODE>
+    # Fix MSVC shit
+    $<$<CXX_COMPILER_ID:MSVC>:_CRT_SECURE_NO_WARNINGS>
+    $<$<CXX_COMPILER_ID:MSVC>:_CRT_SECURE_NO_DEPRECATE>
+    $<$<CXX_COMPILER_ID:MSVC>:_CRT_NONSTDC_NO_WARNINGS>
+    $<$<CXX_COMPILER_ID:MSVC>:_CRT_NONSTDC_NO_DEPRECATE>
+    # Fix Windows header file shit
+    $<$<BOOL:${WIN32}>:WIN32_LEAN_AND_MEAN>
+    $<$<BOOL:${WIN32}>:NOMINMAX>
+PUBLIC
+    $<$<BOOL:${YYCC_CHARCONV_HAS_CHARS_FORMAT}>:YYCC_CHARCONV_HAS_CHARS_FORMAT>
+    $<$<BOOL:${YYCC_CHARCONV_HAS_FROM_CHARS_RESULT}>:YYCC_CHARCONV_HAS_FROM_CHARS_RESULT>
+    $<$<BOOL:${YYCC_CHARCONV_HAS_TO_CHARS_RESULT}>:YYCC_CHARCONV_HAS_TO_CHARS_RESULT>
+    $<$<BOOL:${YYCC_CHARCONV_HAS_FROM_CHARS_INT}>:YYCC_CHARCONV_HAS_FROM_CHARS_INT>
+    $<$<BOOL:${YYCC_CHARCONV_HAS_FROM_CHARS_FLOAT}>:YYCC_CHARCONV_HAS_FROM_CHARS_FLOAT>
+    $<$<BOOL:${YYCC_CHARCONV_HAS_TO_CHARS_INT}>:YYCC_CHARCONV_HAS_TO_CHARS_INT>
+    $<$<BOOL:${YYCC_CHARCONV_HAS_TO_CHARS_FLOAT}>:YYCC_CHARCONV_HAS_TO_CHARS_FLOAT>
+
 )
 target_compile_options(YYCCommonplace
-# Order build as UTF-8 in MSVC
+PUBLIC
-PRIVATE
+    # Order build as UTF-8 in MSVC
     $<$<CXX_COMPILER_ID:MSVC>:/utf-8>
+    # Order preprocessor conformance mode (fix __VA_OPT__ error in MSVC)
+    $<$<CXX_COMPILER_ID:MSVC>:/Zc:preprocessor>
+    # Resolve MSVC __cplusplus macro value error.
+    $<$<CXX_COMPILER_ID:MSVC>:/Zc:__cplusplus>
 )
 
+# Fix GCC std::stacktrace link error
+if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+    if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 14)
+        target_link_libraries(YYCCommonplace PRIVATE stdc++exp)
+    else ()
+        target_link_libraries(YYCCommonplace PRIVATE stdc++_libbacktrace)
+    endif ()
+endif ()
+
 # Install binary and headers
 install(TARGETS YYCCommonplace
     EXPORT YYCCommonplaceTargets

src/COMHelper.cpp

@@ -1,48 +0,0 @@
-#include "COMHelper.hpp"
-#if YYCC_OS == YYCC_OS_WINDOWS
-
-namespace YYCC::COMHelper {
-
-	/**
-	 * @brief The guard for initialize COM environment.
-	 * @details This class will try initializing COM environment by calling CoInitialize when constructing,
-	 * and it also will try uninitializing COM environment when destructing.
-	 * If initialization failed, uninitialization will not be executed.
-	*/
-	class ComGuard {
-	public:
-		ComGuard() : m_HasInit(false) {
-			HRESULT hr = CoInitializeEx(NULL, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE);
-			if (SUCCEEDED(hr)) m_HasInit = true;
-		}
-		~ComGuard() {
-			if (m_HasInit) {
-				CoUninitialize();
-			}
-		}
-
-		bool IsInitialized() const {
-			return m_HasInit;
-		}
-
-	protected:
-		bool m_HasInit;
-	};
-
-	/**
-	 * @brief The instance of COM environment guard.
-	 * @details Dialog related function need COM environment,
-	 * so we need initializing COM environment when loading this module,
-	 * and uninitializing COM environment when we no longer use this module.
-	 * So we use a static instance in here.
-	 * And make it be const so no one can change it.
-	*/
-	static const ComGuard c_ComGuard {};
-
-	bool IsInitialized() {
-		return c_ComGuard.IsInitialized();
-	}
-
-}
-
-#endif