x

Author: soburi

documentation/idl_codegen.md

@@ -85,7 +85,7 @@ Defined as `google.protobuf.ServiceOptions` extensions:
 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`).
+   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`). Generated `Service` class declarations inherit all ancestor `Ifc` classes (direct and indirect) in lineage order.
 
 ## Recommended Mapping
 
@@ -109,6 +109,7 @@ The generator intentionally fails when configuration is inconsistent:
 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
+6. If `base_services` is set and `generate_service_class = true`, each ancestor service must also set `generate_ifc_class = true`
 
 ## Example
 

idl/proto/hardware_serial.proto

@@ -14,6 +14,7 @@ import "google/protobuf/wrappers.proto";
 
 service HardwareSerial {
   option (arduino.base_services) = "Stream";
+  option (arduino.generate_api_class) = true;
   option (arduino.generate_ifc_class) = true;
   option (arduino.generate_service_class) = true;
   option (arduino.generate_service_impl_class) = true;

tools/protoc-gen-arduinoif

@@ -319,6 +319,21 @@ def _collect_lineage_includes(
     return _dedupe_ordered(includes)
 
 
+def _service_class_name(service) -> str:
+    return _get_string_option(service.options, SERVICE_SERVICE_CLASS_NAME_TAG).strip() or f"{service.name}Service"
+
+
+def _ifc_class_name(service) -> str:
+    return _get_string_option(service.options, SERVICE_IFC_CLASS_NAME_TAG).strip() or f"{service.name}Ifc"
+
+
+def _class_decl(class_name: str, base_classes: List[str]) -> str:
+    if not base_classes:
+        return f"class {class_name} {{"
+    bases = ", ".join(f"public {base_class}" for base_class in base_classes)
+    return f"class {class_name} : {bases} {{"
+
+
 def _field_type(field: FieldDescriptorProto) -> str:
     default_types = {
         FieldDescriptorProto.TYPE_BOOL: "bool",
@@ -602,7 +617,7 @@ def _generate_service_headers(
 ) -> Dict[str, str]:
     ifc_class_name = _get_string_option(service.options, SERVICE_IFC_CLASS_NAME_TAG).strip() or f"{service.name}Ifc"
     api_class_name = _get_string_option(service.options, SERVICE_API_CLASS_NAME_TAG).strip() or f"{service.name}Api"
-    service_class_name = _get_string_option(service.options, SERVICE_SERVICE_CLASS_NAME_TAG).strip() or f"{service.name}Service"
+    service_class_name = _service_class_name(service)
     service_impl_class_name = _get_string_option(service.options, SERVICE_SERVICE_IMPL_CLASS_NAME_TAG).strip() or f"{service.name}ServiceImpl"
     api_member_name = _get_string_option(service.options, SERVICE_API_MEMBER_NAME_TAG).strip() or "api_"
     generate_ifc_class = _get_bool_option(service.options, SERVICE_GENERATE_IFC_CLASS_TAG, True)
@@ -620,6 +635,7 @@ def _generate_service_headers(
     namespace_name = _cpp_namespace_from_package(package_name)
     own_method_specs = [_method_spec_from_descriptor(method, message_map) for method in service.method]
     lineage = _collect_service_lineage(service_full_name, service_index, lineage_cache)
+    ancestor_services = lineage[:-1]
     lineage_method_specs = _collect_lineage_methods(lineage, service_index, message_map)
     ifc_methods = [spec for spec in own_method_specs if spec.source_virtual]
     api_methods = [spec for spec in lineage_method_specs if spec.emit_api and spec.source_virtual]
@@ -644,6 +660,23 @@ def _generate_service_headers(
             )
         service_impl_methods = [spec for spec in service_methods if spec.call_name in api_callable]
     include_list = _collect_lineage_includes(lineage, service_index)
+    service_base_ifc_class_names: List[str] = []
+    service_base_ifc_header_names: List[str] = []
+    for ancestor_full_name in ancestor_services:
+        ancestor_service, _ = service_index[ancestor_full_name]
+        ancestor_generates_ifc_class = _get_bool_option(
+            ancestor_service.options,
+            SERVICE_GENERATE_IFC_CLASS_TAG,
+            True,
+        )
+        if generate_service_class and not ancestor_generates_ifc_class:
+            raise ValueError(
+                f"{service.name}: ancestor service '{ancestor_service.name}' must set generate_ifc_class=true"
+            )
+        service_base_ifc_class_names.append(_ifc_class_name(ancestor_service))
+        service_base_ifc_header_names.append(_service_header_name(ancestor_service.name))
+    service_base_ifc_class_names = _dedupe_ordered(service_base_ifc_class_names)
+    service_base_ifc_header_names = _dedupe_ordered(service_base_ifc_header_names)
     stem = _service_header_stem(service.name)
     ifc_header_name = _service_header_name(service.name)
     api_header_name = f"{stem}_api.hpp"
@@ -693,8 +726,9 @@ def _generate_service_headers(
         outputs[api_header_name] = _render_header(api_includes, namespace_name, body_lines)
 
     if generate_service_class:
+        service_includes = _dedupe_ordered([*service_base_ifc_header_names, *include_list])
         body_lines = []
-        body_lines.append(f"class {service_class_name} {{")
+        body_lines.append(_class_decl(service_class_name, service_base_ifc_class_names))
         body_lines.append("public:")
         body_lines.append(f"  virtual ~{service_class_name}() = default;")
         body_lines.append("")
@@ -704,7 +738,7 @@ def _generate_service_headers(
             lambda spec: body_lines.append(f"  virtual {spec.decl} = 0;"),
         )
         body_lines.append("};")
-        outputs[service_header_name] = _render_header(include_list, namespace_name, body_lines)
+        outputs[service_header_name] = _render_header(service_includes, namespace_name, body_lines)
 
     if generate_service_impl_class:
         service_impl_includes = [service_header_name, *include_list]