Initial Commit

Author: j2doll

AutoDescribe.hpp

@@ -4,7 +4,8 @@
 #define BOOST_AUTO_DESCRIBE_HPP
 
 // AutoDescribe.hpp
-// "필드 시퀀스"를 한 번만 정의하면 구조체와 BOOST_DESCRIBE_STRUCT를 자동 생성하는 유틸
+// A utility that generates both the struct definition and BOOST_DESCRIBE_STRUCT automatically
+// by defining the "field sequence" only once.
 
 #include <boost/preprocessor.hpp>
 #include <boost/describe.hpp>
@@ -15,19 +16,19 @@ BOOST_PP_TUPLE_ELEM(3, 1, elem) BOOST_PP_TUPLE_ELEM(3, 0, elem){  \
     BOOST_PP_TUPLE_ELEM(3, 2, elem)                               \
 };
 
-// describe에 넣을 멤버 이름 목록 추출
+// Extract the list of member names for use in describe
 #define ADH_EXTRACT_NAME(r, data, i, elem)                       \
 BOOST_PP_COMMA_IF(i) BOOST_PP_TUPLE_ELEM(3, 0, elem)
 
-// 구조체와 describe를 한 번에 생성
+// Generate both the struct and its describe at once
 #define ADH_MAKE_STRUCT_AND_DESCRIBE(name, fields_seq)            \
     struct name {                                                 \
         BOOST_PP_SEQ_FOR_EACH(ADH_DECLARE_MEMBER, _, fields_seq)  \
 };                                                                \
     BOOST_DESCRIBE_STRUCT(                                        \
-          name,                                                   \
-          (),                                                     \
- (BOOST_PP_SEQ_FOR_EACH_I(ADH_EXTRACT_NAME, _, fields_seq))       \
-)
+                                                                  name,                                                   \
+                                                                  (),                                                     \
+                                                                  (BOOST_PP_SEQ_FOR_EACH_I(ADH_EXTRACT_NAME, _, fields_seq))       \
+        )
 
 #endif // AUTODESCRIBE_HPP

CMakeLists.txt

@@ -9,9 +9,9 @@ if(POLICY CMP0167)
   cmake_policy(SET CMP0167 NEW)
 endif()
 
-# ---- vcpkg (요청하신 MinGW 블록 그대로 유지) ----
+# ---- vcpkg (Keep the requested MinGW block as is) ----
 if (WIN32 AND MSVC)
-  # MSVC 전용 설정 필요시 여기에
+  # Add MSVC-specific settings here if needed
 endif()
 
 if (WIN32 AND MINGW)
@@ -21,7 +21,7 @@ if (WIN32 AND MINGW)
   set(CMAKE_TOOLCHAIN_FILE "${VCPKG_ROOT}/vcpkg/scripts/buildsystems/vcpkg.cmake")
 endif()
 
-# (선택) Linux 감지
+# (Optional) Detect Linux
 if(UNIX AND NOT WIN32)
   message(STATUS "Detected Linux")
   if (EXISTS "/etc/os-release")
@@ -50,23 +50,23 @@ if (WIN32 AND NOT DEFINED LIBCLANG_DLL)
 endif()
 
 if (WIN32 AND NOT LIBCLANG_DLL)
-  message(FATAL_ERROR "LIBCLANG_DLL 경로를 지정해 주세요. 예) -DLIBCLANG_DLL=C:/Users/<you>/scoop/apps/llvm/current/bin/libclang.dll")
+  message(FATAL_ERROR "Please specify the LIBCLANG_DLL path. Example: -DLIBCLANG_DLL=C:/Users/<you>/scoop/apps/llvm/current/bin/libclang.dll")
 endif()
 
 # ---- Boost(JSON) ----
 find_package(Boost 1.75 CONFIG REQUIRED COMPONENTS json)
 
-# ---- 경로/파일 ----
+# ---- Paths / Files ----
 set(SRC_DIR      "${CMAKE_CURRENT_SOURCE_DIR}")
 set(TOOL_DIR     "${SRC_DIR}/tools")
 set(MODEL_HEADER "${SRC_DIR}/model.hpp")
-# 요청대로 소스 트리에 생성
+# Create in the source tree as requested
 set(GEN_HEADER   "${SRC_DIR}/describe_all.gen.hpp")
 
-# 생성물 표시
+# Mark generated files
 set_source_files_properties("${GEN_HEADER}" PROPERTIES GENERATED TRUE)
 
-# ---- 생성 규칙: OUTPUT 한 번만 정의 ----
+# ---- Generation rule: define OUTPUT only once ----
 add_custom_command(
   OUTPUT "${GEN_HEADER}"
   COMMAND ${CMAKE_COMMAND} -E env PYTHONUTF8=1
@@ -82,10 +82,10 @@ add_custom_command(
   VERBATIM
 )
 
-# 이 타깃은 파일 생성 결과에만 의존
+# This target depends only on the generated file result
 add_custom_target(gen_describe DEPENDS "${GEN_HEADER}")
 
-# ---- 실행 파일 ----
+# ---- Executable ----
 add_executable(demo
   "${SRC_DIR}/main.cpp"
   "${SRC_DIR}/AutoDescribe.hpp"
@@ -103,7 +103,7 @@ else()
   target_compile_options(demo PRIVATE -Wall -Wextra -Wpedantic -Wno-variadic-macros)
 endif()
 
-# ---- IDE 전용 파일 노출 ----
+# ---- Expose IDE-only files ----
 set(IDE_ONLY_FILES
   "${TOOL_DIR}/gen_all_structs.py"
   "${TOOL_DIR}/gen_fields.py"

JsonCodec.hpp

@@ -1,5 +1,5 @@
 // JsonCodec.hpp
-// Boost.JSON + Boost.Describe 래퍼 (헤더 전용, Boost 1.88 호환)
+// Boost.JSON + Boost.Describe wrapper (header-only, compatible with Boost 1.88)
 #pragma once
 
 #ifndef BOOST_JSON_CODEC_HPP
@@ -19,11 +19,11 @@ namespace json = boost::json;
 namespace bd   = boost::describe;
 namespace mp11 = boost::mp11;
 
-// Boost 1.88: has_describe_members<T> (접근자 인자 없음)
+// Boost 1.88: has_describe_members<T> (no accessor arguments)
 template<class T>
 using EnableIfDescribed = std::enable_if_t<bd::has_describe_members<T>::value>;
 
-// describe된 타입 공통 직렬화 (struct -> JSON)
+// Common serialization for described types (struct -> JSON)
 template<class T, class = EnableIfDescribed<T>>
 void tag_invoke(json::value_from_tag, json::value& jv, T const& t) {
     json::object obj;
@@ -38,7 +38,7 @@ class JsonCodec {
 public:
     enum class MissingPolicy { Strict, Lenient };
 
-    // 간단 프리터(문자열 기반 pretty): 작은 유틸
+    // Simple pretty printer (string-based pretty print): small utility
     static std::string simple_pretty(std::string s, int indent = 2) {
         std::string out; out.reserve(s.size() + s.size()/4);
         int level = 0; bool in_str = false; bool esc = false;
@@ -88,7 +88,7 @@ class JsonCodec {
 
     template<class T, class = EnableIfDescribed<T>>
     static T fromValue(const json::value& jv, MissingPolicy policy = MissingPolicy::Strict) {
-        if (!jv.is_object()) throw std::runtime_error("JSON 루트가 객체가 아닙니다.");
+        if (!jv.is_object()) throw std::runtime_error("JSON root is not an object.");
         const json::object& obj = jv.as_object();
 
         T out{};
@@ -98,13 +98,13 @@ class JsonCodec {
             auto it = obj.find(D.name);
             if (it == obj.end()) {
                 if (policy == MissingPolicy::Strict)
-                    throw std::runtime_error(std::string("필수 키 누락: ") + D.name);
-                return; // Lenient: 기본값 유지
+                    throw std::runtime_error(std::string("Missing required key: ") + D.name);
+                return; // Lenient: keep default value
             }
             try {
                 (out.*(D.pointer)) = json::value_to<MemberType>(it->value());
             } catch (const std::exception& e) {
-                throw std::runtime_error(std::string("필드 변환 실패: ") + D.name + " - " + e.what());
+                throw std::runtime_error(std::string("Field conversion failed: ") + D.name + " - " + e.what());
             }
         });
         return out;
@@ -120,7 +120,7 @@ class JsonCodec {
     static T fromString(const std::string& s, MissingPolicy policy = MissingPolicy::Strict) {
         boost::system::error_code ec;
         json::value v = json::parse(s, ec);
-        if (ec) throw std::runtime_error("JSON 파싱 실패: " + ec.message());
+        if (ec) throw std::runtime_error("JSON parsing failed: " + ec.message());
         return fromValue<T>(v, policy);
     }
 
@@ -142,24 +142,24 @@ class JsonCodec {
     static json::value parse(const std::string& s) {
         boost::system::error_code ec;
         json::value v = json::parse(s, ec);
-        if (ec) throw std::runtime_error("JSON 파싱 실패: " + ec.message());
+        if (ec) throw std::runtime_error("JSON parsing failed: " + ec.message());
         return v;
     }
 
     static void saveValue(const std::string& path, const json::value& v, bool pretty = true) {
         std::ofstream ofs(path, std::ios::binary);
-        if (!ofs) throw std::runtime_error("파일을 쓸 수 없습니다: " + path);
+        if (!ofs) throw std::runtime_error("Cannot write to file: " + path);
         std::string s = dump(v, pretty);
         ofs.write(s.data(), static_cast<std::streamsize>(s.size()));
     }
 
     static json::value loadValue(const std::string& path) {
         std::ifstream ifs(path, std::ios::binary);
-        if (!ifs) throw std::runtime_error("파일을 열 수 없습니다: " + path);
+        if (!ifs) throw std::runtime_error("Cannot open file: " + path);
         std::string s((std::istreambuf_iterator<char>(ifs)), std::istreambuf_iterator<char>());
         boost::system::error_code ec;
         json::value v = json::parse(s, ec);
-        if (ec) throw std::runtime_error("JSON 파싱 실패: " + ec.message());
+        if (ec) throw std::runtime_error("JSON parsing failed: " + ec.message());
         return v;
     }
 };

README.ko.md

@@ -0,0 +1,46 @@
+# Boost.JSON AutoDescribe 데모
+
+[View in English](README.md)
+
+## 개요
+이 프로젝트는 **Boost.JSON**과 **Boost.Describe**를 이용하여 C++ 구조체와 JSON 간의 자동 변환을 구현한 예제입니다.  
+"필드 시퀀스"를 한 번만 정의하면 구조체 정의와 `BOOST_DESCRIBE_STRUCT` 선언을 자동으로 생성하여 코드 중복을 줄이고 유지보수성을 향상시킵니다.
+
+## 주요 기능
+- **자동 구조체 기술**  
+  `AutoDescribe.hpp`를 사용해 구조체 정의와 `BOOST_DESCRIBE_STRUCT`를 동시에 생성합니다.
+
+- **JSON 직렬화 / 역직렬화**  
+  `JsonCodec.hpp`를 통해 기술된 구조체를 Boost.JSON을 사용하여 손쉽게 JSON으로 변환하거나, JSON에서 구조체로 변환할 수 있습니다.
+
+- **Pretty 출력**  
+  가독성을 높이기 위한 내장 프리티 프린터 제공.
+
+- **파일 입출력**  
+  JSON 데이터를 파일에 저장하고 파일에서 불러오는 기능 제공.
+
+- **Clang 기반 코드 생성**  
+  Python 도구(`gen_fields.py`, `gen_all_structs.py`)가 libclang을 사용하여 헤더를 스캔하고 `BOOST_DESCRIBE_STRUCT`를 자동 생성합니다.
+
+## 의존성
+- **Boost** >= 1.75 (Boost 1.88에서 테스트됨)
+- **Python 3** (`clang` 바인딩 포함)
+- **libclang** (LLVM)
+
+## 빌드 방법
+```bash
+cmake -B build -S .   -DCMAKE_BUILD_TYPE=Release   -DLIBCLANG_DLL=/path/to/libclang.dll
+cmake --build build
+```
+
+## 예제
+```cpp
+hello::world::User user{"John Doe", 30, true, {"[email protected]", 95.5}, {}};
+std::string json_str = JsonCodec::toString(user, true);
+std::cout << json_str << std::endl;
+
+hello::world::User loaded = JsonCodec::fromString<hello::world::User>(json_str);
+```
+
+## 라이선스
+이 프로젝트는 MIT 라이선스를 따릅니다. 자세한 내용은 [LICENSE](LICENSE) 파일을 참고하세요.

README.md

@@ -1,2 +1,46 @@
-# boost.json.codec
-Using Boost JSON 
+# Boost.JSON AutoDescribe Demo
+
+[한국어 설명 보기](README.ko.md)
+
+## Overview
+This project demonstrates an automatic conversion system between C++ structures and JSON using **Boost.JSON** and **Boost.Describe**.  
+By defining the "field sequence" only once, it can automatically generate both the struct definition and `BOOST_DESCRIBE_STRUCT` declarations, reducing redundancy and improving maintainability.
+
+## Features
+- **Automatic Struct Description**  
+  Uses `AutoDescribe.hpp` to generate struct definitions and `BOOST_DESCRIBE_STRUCT` at the same time.
+
+- **JSON Serialization / Deserialization**  
+  `JsonCodec.hpp` provides easy-to-use functions to convert described structs to and from JSON using Boost.JSON.
+
+- **Pretty Printing**  
+  Built-in pretty printer for better readability.
+
+- **File I/O**  
+  Save and load JSON data directly to and from files.
+
+- **Clang-based Code Generation**  
+  Python tools (`gen_fields.py`, `gen_all_structs.py`) use libclang to scan headers and generate `BOOST_DESCRIBE_STRUCT` automatically.
+
+## Dependencies
+- **Boost** >= 1.75 (Tested with Boost 1.88)
+- **Python 3** with `clang` bindings
+- **libclang** (LLVM)
+
+## Building
+```bash
+cmake -B build -S .   -DCMAKE_BUILD_TYPE=Release   -DLIBCLANG_DLL=/path/to/libclang.dll
+cmake --build build
+```
+
+## Example
+```cpp
+hello::world::User user{"John Doe", 30, true, {"[email protected]", 95.5}, {}};
+std::string json_str = JsonCodec::toString(user, true);
+std::cout << json_str << std::endl;
+
+hello::world::User loaded = JsonCodec::fromString<hello::world::User>(json_str);
+```
+
+## License
+This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.

main.cpp

@@ -2,8 +2,8 @@
 
 #include "model.hpp"
 #include "AutoDescribe.hpp"
-#include "describe_all.gen.hpp"   // describe 먼저
-#include "JsonCodec.hpp"          // 그다음 JsonCodec
+#include "describe_all.gen.hpp"   // describe first
+#include "JsonCodec.hpp"          // then JsonCodec
 
 #include <iostream>
 #include <string>
@@ -12,7 +12,7 @@
 int main() {
     try {
         hello::world::User u1{
-            "홍길동",
+            "Hong Gil-dong",
             29,
             true,
             hello::world::Profile{"[email protected]", 98.5},
@@ -26,7 +26,7 @@ int main() {
         std::cout << "[User -> JSON]\n" << s1 << "\n\n";
 
         const char* js = R"({
-            "name": "이몽룡",
+            "name": "Lee Mong-ryong",
             "age": 21,
             "admin": false,
             "profile": { "email": "[email protected]", "score": 91.2 },
@@ -45,23 +45,23 @@ int main() {
                   << ", admin="<< (u2.admin ? "true":"false")
                   << ", email="<< u2.profile.email
                   << ", score="<< u2.profile.score
-                  << ", projects=" << u2.projects.size() << "개\n";
+                  << ", projects=" << u2.projects.size() << " items\n";
         if (!u2.projects.empty()) {
-            std::cout << "  첫 프로젝트: " << u2.projects[0].title << "\n";
+            std::cout << "  First project: " << u2.projects[0].title << "\n";
         }
 
         JsonCodec::saveFile("user.json", u1, true);
 
         hello::world::User u3 =
             JsonCodec::loadFile<hello::world::User>("user.json", JsonCodec::MissingPolicy::Lenient);
 
-        std::cout << "[파일 로드] name=" << u3.name
-                  << ", projects=" << u3.projects.size() << "개\n";
+        std::cout << "[File Load] name=" << u3.name
+                  << ", projects=" << u3.projects.size() << " items\n";
 
         NonNamespaceProfile nnp1;
 
     } catch (const std::exception& e) {
-        std::cerr << "[오류] " << e.what() << "\n";
+        std::cerr << "[Error] " << e.what() << "\n";
         return 1;
     }
     return 0;

tools/gen_fields.py

@@ -19,9 +19,10 @@ def setup_libclang(path_from_cli: str | None):
 def parse_args():
     ap = argparse.ArgumentParser()
     ap.add_argument("--libclang", default=None)
-    ap.add_argument("--all", action="store_true", help="헤더 전체를 스캔하여 해당 파일에 정의된 모든 struct/class를 기술")
+    ap.add_argument("--all", action="store_true",
+                    help="Scan the entire header and describe all struct/class definitions in that file")
     ap.add_argument("header")
-    ap.add_argument("struct", nargs="?", help="--all 미사용 시 단일 구조체 이름")
+    ap.add_argument("struct", nargs="?", help="Struct name when --all is not used")
     return ap.parse_args()
 
 def norm(p: str) -> str:
@@ -56,7 +57,7 @@ def collect_fields(node):
     return names
 
 def should_skip_name(name: str) -> bool:
-    # 시스템/런타임 내부 심볼 제외
+    # Exclude system/runtime internal symbols
     return name.startswith("_")
 
 def main():