skir-cc-gen 0.0.3 → 1.0.1

package/README.md

@@ -7,20 +7,65 @@ Official plugin for generating C++ code from [.skir](https://github.com/gepheum/
 
 Targets C++17 and higher.
 
-## Installation
-
-From your project's root directory, run `npm i --save-dev skir-cc-gen`.
+## Set up
 
 In your `skir.yml` file, add the following snippet under `generators`:
 ```yaml
   - mod: skir-cc-gen
+    outDir: ./src/skirout
     config:
-      writeGoogleTestHeaders: true
+      writeGoogleTestHeaders: true  # If you  use GoogleTest
+```
+
+## Runtime dependencies
+
+The generated C++ code depends on the [skir client library](https://github.com/gepheum/skir-cc-gen/tree/main/client), [absl](https://abseil.io/) and optionally [GoogleTest](https://github.com/google/googletest).
+
+### If you use CMake
+
+Add this to your `CMakeLists.txt`:
+
+```cmake
+include(FetchContent)
+
+# Should be ON if writeGoogleTestHeaders is true 
+option(BUILD_TESTING "Build tests" OFF)
+
+# Abseil (required, version 20250814.0+)
+FetchContent_Declare(
+  absl
+  GIT_REPOSITORY https://github.com/abseil/abseil-cpp.git
+  GIT_TAG        20250814.1  # Use 20250814.0 or later
+)
+set(ABSL_PROPAGATE_CXX_STD ON)
+FetchContent_MakeAvailable(absl)
+
+if(BUILD_TESTING)
+  # GoogleTest (optional - only if you use writeGoogleTestHeaders)
+  FetchContent_Declare(
+    googletest
+    GIT_REPOSITORY https://github.com/google/googletest.git
+    GIT_TAG        v1.15.2  # Pick the latest tag
+  )
+  set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+  FetchContent_MakeAvailable(googletest)
+endif()
+
+# skir-client
+FetchContent_Declare(
+  skir-client
+  GIT_REPOSITORY https://github.com/gepheum/skir-cc-gen.git
+  GIT_TAG        main  # Or pick a specific commit/tag
+  SOURCE_SUBDIR  client
+)
+FetchContent_MakeAvailable(skir-client)
 ```
 
-The `npm run skir` command will now generate C++ code within the `skirout` directory.
+See this [example](https://github.com/gepheum/skir-cc-example/blob/main/CMakeLists.txt).
+
+### If you use Bazel
 
-For more information, see this C++ project [example](https://github.com/gepheum/skir-cc-example).
+Refer to this example [BUILD.bazel](https://github.com/gepheum/skir-cc-example/blob/main/BUILD.bazel) file.
 
 ## C++ generated code guide
 
@@ -36,6 +81,7 @@ replaced with underscores.
 ```c++
 #include "skirout/user.h"
 
+using ::skirout_user::SubscriptionStatus;
 using ::skirout_user::User;
 using ::skirout_user::UserRegistry;
 ```
@@ -64,7 +110,7 @@ User jane = {
     .user_id = 43,
 };
 
-// ${StructName}::whole forces you to initialize all the fields of the struct.
+// ${Struct}::whole forces you to initialize all the fields of the struct.
 // You will get a compile-time error if you miss one.
 User lyla = User::whole{
     .name = "Lyla Doe",
@@ -86,20 +132,22 @@ User lyla = User::whole{
 
 ```c++
 
-// Use skirout::${kFieldName} for constant variants.
-User::SubscriptionStatus john_status = skirout::kFree;
-User::SubscriptionStatus jane_status = skirout::kPremium;
+// Use skirout::${kFieldName} or ${Enum}::${kFieldName} for constant variants.
+SubscriptionStatus john_status = skirout::kFree;
+SubscriptionStatus jane_status = skirout::kPremium;
+SubscriptionStatus lara_status = SubscriptionStatus::kFree;
 
 // Compilation error: MONDAY is not a field of the SubscriptionStatus enum.
-// User::SubscriptionStatus sara_status = skirout::kMonday;
-
-// Use skirout::wrap_${field_name} for data variants.
-User::SubscriptionStatus jade_status =
-    skirout::wrap_trial_start_time(absl::FromUnixMillis(1743682787000));
-
-// The ${kFieldName} and wrap_${field_name} symbols are also defined in the
-// generated class.
-User::SubscriptionStatus lara_status = User::SubscriptionStatus::kFree;
+// SubscriptionStatus sara_status = skirout::kMonday;
+
+// Use wrap_${field_name} for wrapper variants.
+SubscriptionStatus jade_status =
+    skirout::wrap_trial(SubscriptionStatus::Trial({
+        .start_time = absl::FromUnixMillis(1743682787000),
+    }));
+SubscriptionStatus roni_status = SubscriptionStatus::wrap_trial({
+    .start_time = absl::FromUnixMillis(1743682787000),
+});
 ```
 
 ### Conditions on enums
@@ -109,28 +157,28 @@ if (john_status == skirout::kFree) {
   std::cout << "John, would you like to upgrade to premium?\n";
 }
 
-// Call is_${field_name}() to check if the enum holds a data variant.
-if (jade_status.is_trial_start_time()) {
-  // as_${field_name}() returns the value held by the enum
-  const absl::Time trial_start_time = jade_status.as_trial_start_time();
-  std::cout << "Jade's trial started on " << trial_start_time << "\n";
+// Call is_${field_name}() to check if the enum holds a wrapper variant.
+if (jade_status.is_trial()) {
+  // as_${field_name}() returns the wrapped value
+  const SubscriptionStatus::Trial& trial = jade_status.as_trial();
+  std::cout << "Jade's trial started on " << trial.start_time << "\n";
 }
 
 // One way to do an exhaustive switch on an enum.
 switch (lara_status.kind()) {
-  case User::SubscriptionStatus::kind_type::kUnknown:
+  case SubscriptionStatus::kind_type::kUnknown:
     // UNKNOWN is the default value for an uninitialized SubscriptionStatus.
     // ...
     break;
-  case User::SubscriptionStatus::kind_type::kFreeConst:
+  case SubscriptionStatus::kind_type::kFreeConst:
     // ...
     break;
-  case User::SubscriptionStatus::kind_type::kPremiumConst:
+  case SubscriptionStatus::kind_type::kPremiumConst:
     // ...
     break;
-  case User::SubscriptionStatus::kind_type::kTrialStartTimeWrapper: {
-    const absl::Time& trial_start_time = lara_status.as_trial_start_time();
-    std::cout << "Lara's trial started on " << trial_start_time << "\n";
+  case SubscriptionStatus::kind_type::kTrialWrapper: {
+    const SubscriptionStatus::Trial& trial = lara_status.as_trial();
+    std::cout << "Lara's trial started on " << trial.start_time << "\n";
   }
 }
 
@@ -145,10 +193,9 @@ struct Visitor {
   void operator()(skirout::k_premium) const {
     std::cout << "Lara's subscription status is PREMIUM\n";
   }
-  void operator()(
-      User::SubscriptionStatus::wrap_trial_start_time_type& w) const {
-    const absl::Time& trial_start_time = w.value;
-    std::cout << "Lara's trial started on " << trial_start_time << "\n";
+  void operator()(SubscriptionStatus::wrap_trial_type& w) const {
+    const SubscriptionStatus::Trial& trial = w.value;
+    std::cout << "Lara's trial started on " << trial.start_time << "\n";
   }
 };
 lara_status.visit(Visitor());
@@ -212,6 +259,13 @@ assert(maybe_jane != nullptr && *maybe_jane == jane);
 
 assert(users.find_or_default(44).name == "Lyla Doe");
 assert(users.find_or_default(45).name == "");
+
+// If multiple items have the same key, find_or_null and find_or_default
+// return the last one. Duplicates are allowed but generally discouraged.
+User evil_lyla = lyla;
+evil_lyla.name = "Evil Lyla";
+users.push_back(evil_lyla);
+assert(users.find_or_default(44).name == "Evil Lyla");
 ```
 
 ### Equality and hashing
@@ -265,7 +319,7 @@ assert(reserialized_type_descriptor.ok());
 ### Static reflection
 
 Static reflection allows you to inspect and modify values of generated
-skir types in a typesafe maneer.
+skir types in a typesafe manner.
 
 See [string_capitalizer.h](https://github.com/gepheum/skir-cc-example/blob/main/string_capitalizer.h).
 
@@ -287,10 +341,10 @@ std::cout << tarzan_copy << "\n";
 //       .picture: "🐒",
 //     },
 //   },
-//   .subscription_status: ::skirout::wrap_trial_start_time(absl::FromUnixMillis(1743592409000 /* 2025-04-02T11:13:29+00:00 */)),
+//   .subscription_status:
+//   ::skirout::wrap_trial_start_time(absl::FromUnixMillis(1743592409000 /*
+//   2025-04-02T11:13:29+00:00 */)),
 // }
-
-// ...
 ```
 
 ### Writing unit tests with GoogleTest
@@ -323,13 +377,14 @@ EXPECT_THAT(john, (StructIs<User>{
 #### Enum matchers
 
 ```c++
-User::SubscriptionStatus john_status = skirout::kFree;
+SubscriptionStatus john_status = skirout::kFree;
 
 EXPECT_THAT(john_status, testing::Eq(skirout::kFree));
 
-User::SubscriptionStatus jade_status =
-    skirout::wrap_trial_start_time(absl::FromUnixMillis(1743682787000));
+SubscriptionStatus jade_status = SubscriptionStatus::wrap_trial(
+    {.start_time = absl::FromUnixMillis(1743682787000)});
 
-EXPECT_THAT(jade_status, IsTrialStartTime());
-EXPECT_THAT(jade_status, IsTrialStartTime(testing::Gt(absl::UnixEpoch())));
+EXPECT_THAT(jade_status, IsTrial());
+EXPECT_THAT(jade_status, IsTrial(StructIs<SubscriptionStatus::Trial>{
+                              .start_time = testing::Gt(absl::UnixEpoch())}));
 ```

package/client/CMakeLists.txt

@@ -0,0 +1,71 @@
+cmake_minimum_required(VERSION 3.20)
+project(skir-client CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# ============================================================================
+# Dependencies - Use existing targets if available, otherwise find them
+# ============================================================================
+
+# Abseil - check if already provided by parent project
+if(NOT TARGET absl::base)
+  find_package(absl REQUIRED)
+endif()
+
+# GoogleTest - check if already provided by parent project
+if(NOT TARGET GTest::gtest)
+  find_package(GTest REQUIRED)
+endif()
+
+# ============================================================================
+# Main skir library
+# ============================================================================
+
+add_library(skir
+  skir.cc
+  skir.h
+)
+
+target_include_directories(skir PUBLIC 
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+  $<INSTALL_INTERFACE:include>
+)
+
+target_link_libraries(skir PUBLIC
+  absl::base
+  absl::flat_hash_map
+  absl::hash
+  absl::check
+  absl::die_if_null
+  absl::status
+  absl::statusor
+  absl::strings
+  absl::time
+  absl::optional
+  absl::variant
+)
+
+# ============================================================================
+# Testing library (interface library with header-only implementation)
+# ============================================================================
+
+add_library(skir_testing INTERFACE)
+
+target_sources(skir_testing INTERFACE
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/skir.testing.h>
+  $<INSTALL_INTERFACE:include/skir.testing.h>
+)
+
+target_include_directories(skir_testing INTERFACE
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+  $<INSTALL_INTERFACE:include>
+)
+
+target_link_libraries(skir_testing INTERFACE
+  skir
+  absl::base
+  absl::die_if_null
+  GTest::gtest
+  GTest::gmock
+)

package/client/skir.cc

@@ -1368,7 +1368,7 @@ void Int64Adapter::Parse(ByteSource& source, int64_t& out) {
   ParseNumber(source, out);
 }
 
-void Uint64Adapter::Append(uint64_t input, ByteSink& out) {
+void Hash64Adapter::Append(uint64_t input, ByteSink& out) {
   if (input < 232) {
     out.Push(input);
   } else if (input < 4294967296) {
@@ -1382,11 +1382,11 @@ void Uint64Adapter::Append(uint64_t input, ByteSink& out) {
   }
 }
 
-void Uint64Adapter::Parse(JsonTokenizer& tokenizer, uint64_t& out) {
+void Hash64Adapter::Parse(JsonTokenizer& tokenizer, uint64_t& out) {
   ParseJsonNumber(tokenizer, out);
 }
 
-void Uint64Adapter::Parse(ByteSource& source, uint64_t& out) {
+void Hash64Adapter::Parse(ByteSource& source, uint64_t& out) {
   ParseNumber(source, out);
 }
 
@@ -1730,8 +1730,8 @@ void ReflectionPrimitiveTypeAdapter::Append(
       out.out += "\"int64\"";
       break;
     }
-    case skir::reflection::PrimitiveType::kUint64: {
-      out.out += "\"uint64\"";
+    case skir::reflection::PrimitiveType::kHash64: {
+      out.out += "\"hash64\"";
       break;
     }
     case skir::reflection::PrimitiveType::kFloat32: {
@@ -1764,7 +1764,7 @@ void ReflectionPrimitiveTypeAdapter::Parse(
           {"bool", skir::reflection::PrimitiveType::kBool},
           {"int32", skir::reflection::PrimitiveType::kInt32},
           {"int64", skir::reflection::PrimitiveType::kInt64},
-          {"uint64", skir::reflection::PrimitiveType::kUint64},
+          {"hash64", skir::reflection::PrimitiveType::kHash64},
           {"float32", skir::reflection::PrimitiveType::kFloat32},
           {"float64", skir::reflection::PrimitiveType::kFloat64},
           {"timestamp", skir::reflection::PrimitiveType::kTimestamp},
@@ -2098,7 +2098,7 @@ void UnrecognizedValues::ParseFrom(JsonTokenizer& tokenizer) {
         break;
       }
       case JsonTokenType::kUnsignedInteger: {
-        Uint64Adapter::Append(tokenizer.state().uint_value, bytes_);
+        Hash64Adapter::Append(tokenizer.state().uint_value, bytes_);
         tokenizer.Next();
         break;
       }
@@ -2252,8 +2252,8 @@ void UnrecognizedValues::AppendTo(DenseJson& out) const {
     const uint8_t byte = *source.pos;
     if (byte <= 234) {
       uint64_t number = 0;
-      Uint64Adapter::Parse(source, number);
-      Uint64Adapter::Append(number, out);
+      Hash64Adapter::Parse(source, number);
+      Hash64Adapter::Append(number, out);
     } else {
       switch (static_cast<uint8_t>(byte - 235)) {
         case 0:

package/client/skir.h

@@ -432,7 +432,7 @@ class keyed_items {
     kUint8,
     kUint16,
     kUint32,
-    kUint64,
+    kHash64,
   };
   SlotType slot_type_ = SlotType::kUint8;
   bool being_mutated_ = false;
@@ -477,7 +477,7 @@ class keyed_items {
       case SlotType::kUint32:
         PutSlot<uint32_t>(key_hash, next_index);
         break;
-      case SlotType::kUint64:
+      case SlotType::kHash64:
         PutSlot<uint64_t>(key_hash, next_index);
         break;
     }
@@ -573,7 +573,7 @@ class keyed_items {
     } else if (capacity <= std::numeric_limits<uint32_t>::max()) {
       return SlotType::kUint32;
     } else {
-      return SlotType::kUint64;
+      return SlotType::kHash64;
     }
   }
 
@@ -765,7 +765,7 @@ enum class PrimitiveType {
   kBool,
   kInt32,
   kInt64,
-  kUint64,
+  kHash64,
   kFloat32,
   kFloat64,
   kTimestamp,
@@ -1406,7 +1406,7 @@ struct Int64Adapter {
   static constexpr bool IsEnum() { return false; }
 };
 
-struct Uint64Adapter {
+struct Hash64Adapter {
   static bool IsDefault(uint64_t input) { return !input; }
 
   template <typename Out>
@@ -1429,7 +1429,7 @@ struct Uint64Adapter {
   static void Parse(ByteSource& source, uint64_t& out);
 
   static skir::reflection::Type GetType(skir_type<uint64_t>) {
-    return skir::reflection::PrimitiveType::kUint64;
+    return skir::reflection::PrimitiveType::kHash64;
   }
 
   static void RegisterRecords(skir_type<uint64_t>,
@@ -1603,7 +1603,7 @@ void GetAdapter(skir_type<T>) {
 inline BoolAdapter GetAdapter(skir_type<bool>);
 inline Int32Adapter GetAdapter(skir_type<int32_t>);
 inline Int64Adapter GetAdapter(skir_type<int64_t>);
-inline Uint64Adapter GetAdapter(skir_type<uint64_t>);
+inline Hash64Adapter GetAdapter(skir_type<uint64_t>);
 inline Float32Adapter GetAdapter(skir_type<float>);
 inline Float64Adapter GetAdapter(skir_type<double>);
 inline TimestampAdapter GetAdapter(skir_type<absl::Time>);
@@ -2364,7 +2364,7 @@ skir::service::HttpHeaders HttplibToSkirHeaders(const HttplibHeaders& input) {
 
 template <typename MethodsTuple, std::size_t... Indices>
 constexpr bool unique_method_numbers_impl(std::index_sequence<Indices...>) {
-  constexpr std::array<int, sizeof...(Indices)> numbers = {
+  constexpr std::array<int64_t, sizeof...(Indices)> numbers = {
       std::get<Indices>(MethodsTuple()).kNumber...};
   for (std::size_t i = 0; i < sizeof...(Indices); ++i) {
     for (std::size_t j = i + 1; j < sizeof...(Indices); ++j) {

package/dist/enum_variant.js

@@ -74,7 +74,7 @@ function usePointer(type) {
         case "bool":
         case "int32":
         case "int64":
-        case "uint64":
+        case "hash64":
         case "float32":
         case "float64":
         case "timestamp":

package/dist/type_speller.js

@@ -61,7 +61,7 @@ export class TypeSpeller {
                         return "::int32_t";
                     case "int64":
                         return "::int64_t";
-                    case "uint64":
+                    case "hash64":
                         return "::uint64_t";
                     case "float32":
                         return "float";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skir-cc-gen",
-  "version": "0.0.3",
+  "version": "1.0.1",
   "description": "",
   "keywords": [],
   "repository": {
@@ -39,7 +39,7 @@
     "lint:fix": "eslint src/**/*.ts --fix"
   },
   "dependencies": {
-    "skir-internal": "^0.0.8",
+    "skir-internal": "^0.1.0",
     "zod": "^4.2.1"
   },
   "devDependencies": {
@@ -53,7 +53,7 @@
     "mocha": "^11.7.5",
     "prettier": "^3.2.4",
     "prettier-plugin-organize-imports": "^4.2.0",
-    "skir": "^0.0.7",
+    "skir": "^1.0.4",
     "ts-node": "^10.9.2",
     "tsx": "^4.21.0",
     "typescript": "^5.2.2",

package/src/enum_variant.ts

@@ -116,7 +116,7 @@ function usePointer(type: ResolvedType): boolean {
     case "bool":
     case "int32":
     case "int64":
-    case "uint64":
+    case "hash64":
     case "float32":
     case "float64":
     case "timestamp":

package/src/type_speller.ts

@@ -73,7 +73,7 @@ export class TypeSpeller {
             return "::int32_t";
           case "int64":
             return "::int64_t";
-          case "uint64":
+          case "hash64":
             return "::uint64_t";
           case "float32":
             return "float";