feat(winrtgen): support constant reference parameters

halildurmus · Sep 14, 2023 · 291b709 · 291b709
1 parent 42eb926
commit 291b709
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 8 deletions.
diff --git a/packages/winrtgen/bin/add_api.dart b/packages/winrtgen/bin/add_api.dart
@@ -135,8 +135,10 @@ void printUsage(ArgParser argParser) {
 }
 
 void main(List<String> args) async {
-  final argParser = buildParser();
+  print('Loading WinRT Metadata...');
+  await WinRTMetadataStore.loadMetadata();
 
+  final argParser = buildParser();
   try {
     final results = argParser.parse(args);
 

diff --git a/packages/winrtgen/lib/src/extensions/type_identifier.dart b/packages/winrtgen/lib/src/extensions/type_identifier.dart
@@ -109,6 +109,12 @@ extension TypeIdentifierHelpers on TypeIdentifier {
 
   bool get isCharType => baseType == BaseType.charType;
 
+  bool get isCLanguageOptionalModifier =>
+      baseType == BaseType.cLanguageOptionalModifier;
+
+  bool get isCLanguageRequiredModifier =>
+      baseType == BaseType.cLanguageRequiredModifier;
+
   bool get isClassType => baseType == BaseType.classTypeModifier;
 
   bool get isClassVariableType =>
@@ -179,7 +185,10 @@ extension TypeIdentifierHelpers on TypeIdentifier {
         name.lastComponent,
       BaseType.genericTypeModifier => _parseGenericTypeIdentifierName(this),
       BaseType.objectType => 'Object',
-      BaseType.referenceTypeModifier => dereference().shortName,
+      BaseType.cLanguageOptionalModifier ||
+      BaseType.cLanguageRequiredModifier ||
+      BaseType.referenceTypeModifier =>
+        dereference().shortName,
       _ => baseType.dartType,
     };
   }

diff --git a/packages/winrtgen/lib/src/models/projection_kind.dart b/packages/winrtgen/lib/src/models/projection_kind.dart
@@ -59,7 +59,9 @@ enum ProjectionKind {
 
   /// Returns the appropriate [ProjectionKind] for the [projection].
   factory ProjectionKind.fromTypeProjection(TypeProjection projection) {
-    if (projection.isReferenceType) {
+    if (projection.isCLanguageOptionalModifier ||
+        projection.isCLanguageRequiredModifier ||
+        projection.isReferenceType) {
       final projectionKind =
           ProjectionKind.fromTypeProjection(projection.dereference());
       return projectionKind == ProjectionKind.dartPrimitive

diff --git a/packages/winrtgen/lib/src/projections/type.dart b/packages/winrtgen/lib/src/projections/type.dart
@@ -70,6 +70,12 @@ final class TypeProjection {
 
   bool get isCharType => typeIdentifier.isCharType;
 
+  bool get isCLanguageOptionalModifier =>
+      typeIdentifier.isCLanguageOptionalModifier;
+
+  bool get isCLanguageRequiredModifier =>
+      typeIdentifier.isCLanguageRequiredModifier;
+
   bool get isClassVariableType => typeIdentifier.isClassVariableType;
 
   bool get isDartPrimitive => switch (dartType) {
@@ -159,6 +165,8 @@ final class TypeProjection {
   TypeProjection dereference() =>
       TypeProjection(typeIdentifier.dereference(), isInParam: isInParam);
 
+  TypeTuple _unwrapCustomModifier() => dereference().projection;
+
   TypeTuple _unwrapGenericTypeArg() {
     final typeArgKind = TypeArgKind.fromName(typeIdentifier.name);
     return switch (typeArgKind) {
@@ -226,6 +234,9 @@ final class TypeProjection {
       return TypeTuple(type, type);
     }
 
+    // Handle custom modifiers (e.g., BaseType.cLanguageOptionalModifier)
+    if (isCLanguageOptionalModifier) return _unwrapCustomModifier();
+
     // Handle generic type argument (e.g., TypeArgKind.inspectable,
     // TypeArgKind.nullableInspectable, TypeArgKind.winrtEnum, or
     // TypeArgKind.winrtFlagsEnum)
@@ -250,6 +261,11 @@ final class TypeTuple {
 
   /// The type, as represented as a struct attribute (e.g., `@Int64()`)
   final String? attribute;
+
+  @override
+  String toString() =>
+      'TypeTuple(nativeType: $nativeType, dartType: $dartType, '
+      'attribute: $attribute)';
 }
 
 const _baseNativeMapping = <BaseType, TypeTuple>{

diff --git a/packages/winrtgen/lib/src/projections/types/struct.dart b/packages/winrtgen/lib/src/projections/types/struct.dart
@@ -27,9 +27,16 @@ final class StructParameterProjection extends ParameterProjection {
       fieldProjections.any((fieldProjection) =>
           fieldProjection.isIReference || fieldProjection.exposedAsStruct);
 
-  TypeIdentifier get typeIdentifier => parameter.isReferenceType
-      ? parameter.typeIdentifier.dereference()
-      : parameter.typeIdentifier;
+  TypeIdentifier get typeIdentifier {
+    if (parameter.typeIdentifier.isCLanguageOptionalModifier &&
+        parameter.typeIdentifier.typeArg!.isReferenceType) {
+      return parameter.typeIdentifier.dereference().dereference();
+    }
+
+    return parameter.isReferenceType
+        ? parameter.typeIdentifier.dereference()
+        : parameter.typeIdentifier;
+  }
 
   @override
   String get type => shortTypeName;
@@ -39,7 +46,10 @@ final class StructParameterProjection extends ParameterProjection {
       isGuid ? '$identifier.toDartGuid()' : '$identifier.toDart()';
 
   @override
-  String get into => '${identifier}NativeStructPtr.ref';
+  String get into => parameter.typeIdentifier.isCLanguageOptionalModifier &&
+          parameter.typeIdentifier.typeArg!.isReferenceType
+      ? '${identifier}NativeStructPtr'
+      : '${identifier}NativeStructPtr.ref';
 
   @override
   List<String> get preambles {

diff --git a/packages/winrtgen/test/projections/parameter_test.dart b/packages/winrtgen/test/projections/parameter_test.dart
@@ -62,6 +62,28 @@ void main() {
       expect(projection.localIdentifier, equals('other.lpVtbl'));
     });
 
+    test('projects constant reference type', () {
+      final methodProjection = MethodProjection.fromTypeAndMethodName(
+          'Windows.Foundation.GuidHelper', 'Equals');
+      final projection = methodProjection.parameters.first;
+      expect(projection, isA<StructParameterProjection>());
+      expect(projection.isInParam, isTrue);
+      expect(projection.isOutParam, isFalse);
+      expect(projection.isNullable, isFalse);
+      expect(projection.type, equals('Guid'));
+      expect(projection.needsAllocation, isTrue);
+      expect(projection.needsDeallocation, isTrue);
+      expect(projection.creatorPreamble, isEmpty);
+      expect(projection.creator, equals('target.toDartGuid()'));
+      expect(projection.into, equals('targetNativeStructPtr'));
+      expect(projection.preambles,
+          equals(['final targetNativeStructPtr = target.toNativeGUID();']));
+      expect(projection.nullCheck, isEmpty);
+      expect(projection.postambles, equals(['free(targetNativeStructPtr);']));
+      expect(projection.identifier, equals('target'));
+      expect(projection.localIdentifier, equals('targetNativeStructPtr'));
+    });
+
     test('projects DateTime', () {
       final methodProjection = MethodProjection.fromTypeAndMethodName(
           'Windows.Globalization.ICalendar', 'SetDateTime');

diff --git a/packages/winrtgen/test/projections/type_test.dart b/packages/winrtgen/test/projections/type_test.dart
@@ -409,7 +409,7 @@ void main() {
       expect(
           typeProjection.toString(),
           equals(
-              "TypeProjection(Calendar, isInParam: false, nativeType: COMObject, dartType: COMObject, pointer: Instance of 'TypeTuple')"));
+              'TypeProjection(Calendar, isInParam: false, nativeType: COMObject, dartType: COMObject, pointer: TypeTuple(nativeType: Pointer<COMObject>, dartType: Pointer<COMObject>, attribute: null))'));
     });
   });
 }