x

Author: soburi

documentation/idl_codegen.md

@@ -23,11 +23,12 @@ The generator supports per-method and per-service options in `arduino_opts.proto
 
 `idl/CMakeLists.txt` already invokes the plugin and emits headers into the build tree.
 
-Typical generated header names:
+Typical generated header names (per service):
 
-1. `print_ifc.hpp`
-2. `stream_ifc.hpp`
-3. `hardware_i2c_ifc.hpp`
+1. `*_ifc.hpp`
+2. `*_api.hpp`
+3. `*_service.hpp`
+4. `*_service_impl.hpp`
 
 ## Method Options
 
@@ -39,6 +40,7 @@ Defined in `idl/proto/arduino_opts.proto` as `google.protobuf.MethodOptions` ext
 4. `source_virtual`
 5. `emit_api`
 6. `emit_service`
+7. `method_visibility`
 
 ### Meaning
 
@@ -50,6 +52,8 @@ Defined in `idl/proto/arduino_opts.proto` as `google.protobuf.MethodOptions` ext
    Whether this method is emitted to generated `Api`.
 4. `emit_service`
    Whether this method is emitted to generated `Service`.
+5. `method_visibility`
+   Access specifier for generated methods. Supported values: `public`, `protected`, `private` (default: `public`).
 
 ## Service Options
 
@@ -64,6 +68,7 @@ Defined as `google.protobuf.ServiceOptions` extensions:
 7. `service_class_name`
 8. `service_impl_class_name`
 9. `api_member_name`
+10. `base_services`
 
 ### Meaning
 
@@ -79,6 +84,8 @@ Defined as `google.protobuf.ServiceOptions` extensions:
    Override generated class names.
 6. `api_member_name`
    Override delegate member name in `ServiceImpl` (default: `api_`).
+7. `base_services`
+   Parent services to inherit from. You can specify a same-package short name (for example `Print`) or a fully-qualified name (for example `arduino.idl.Print` or `.arduino.idl.Print`).
 
 ## Recommended Mapping
 
@@ -101,6 +108,7 @@ The generator intentionally fails when configuration is inconsistent:
 2. `generate_service_impl_class = true` requires `generate_service_class = true`
 3. `generate_api_class = true` rejects methods with `emit_api = true` and `source_virtual = false`
 4. `generate_service_impl_class = true` with `generate_api_class = true` requires all `Service` methods to be callable on generated `Api`
+5. Cyclic `base_services` references are rejected
 
 ## Example
 
@@ -122,12 +130,14 @@ service Demo {
   option (arduino.service_class_name) = "DemoServiceCustom";
   option (arduino.service_impl_class_name) = "DemoServiceImplCustom";
   option (arduino.api_member_name) = "delegate_";
+  option (arduino.base_services) = "Print";
 
   rpc Read(google.protobuf.Empty) returns (google.protobuf.Empty) {
     option (arduino.cpp_decl) = "int read()";
     option (arduino.source_virtual) = true;
     option (arduino.emit_api) = true;
     option (arduino.emit_service) = true;
+    option (arduino.method_visibility) = "public";
   }
 }
 ```

idl/proto/arduino_opts.proto

@@ -22,6 +22,7 @@ extend google.protobuf.MethodOptions {
   bool source_virtual = 50111;
   bool emit_api = 50112;
   bool emit_service = 50113;
+  string method_visibility = 50114;
 }
 
 extend google.protobuf.ServiceOptions {
@@ -34,4 +35,5 @@ extend google.protobuf.ServiceOptions {
   string service_class_name = 50213;
   string service_impl_class_name = 50214;
   string api_member_name = 50215;
+  repeated string base_services = 50216;
 }

idl/proto/hardware_serial.proto

@@ -13,6 +13,12 @@ import "google/protobuf/empty.proto";
 import "google/protobuf/wrappers.proto";
 
 service HardwareSerial {
+  option (arduino.base_services) = "Stream";
+  option (arduino.generate_ifc_class) = true;
+  option (arduino.generate_service_class) = true;
+  option (arduino.generate_service_impl_class) = true;
+  option (arduino.api_class_name) = "arduino::HardwareSerial";
+
   rpc BeginBaud(google.protobuf.UInt64Value) returns (google.protobuf.Empty) {
     option (arduino.cpp_decl) = "void begin(unsigned long baudrate)";
   }

idl/proto/stream.proto

@@ -13,6 +13,8 @@ import "google/protobuf/empty.proto";
 import "google/protobuf/wrappers.proto";
 
 service Stream {
+  option (arduino.base_services) = "Print";
+
   rpc Available(google.protobuf.Empty) returns (google.protobuf.Int32Value) {
     option (arduino.cpp_decl) = "int available()";
   }