feat: iOS 部分适配 DartNative 0.4 版本

Author: yulingtianxia

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [2.0.0] - 2021-11-08
+
+* Adapted to version 0.4 of dart_native. 
+
 ## [1.0.2] - 2020-05-25
 
 * Support generating Flutter package.

bin/codegen.js

@@ -2,7 +2,7 @@
 import { program } from 'commander'
 import { main } from '../lib/main.js'
 
-program.version('1.2.2')
+program.version('2.0.0')
 
 program
     .arguments('<input>', 'Iutput directory')

lib/main.js

@@ -10,6 +10,7 @@ const dnPartExtension = 'dnpart'
 var outputDir
 var projectName
 var packageSet = new Set()
+var enumeratorTypeNames = []
 var isMainThread = false
 
 const scriptForObjC = './lib/objc/DNObjectiveCConverter.js'
@@ -85,10 +86,12 @@ function writeOutputToFileByPath(result, srcPath) {
 }
 
 function mergeFiles(filePaths) {
-    if (!filePaths || filePaths.length <= 1) {
-        return
+    if (!filePaths || filePaths.length == 0) {
+        return ''
+    }
+    if (filePaths.length == 1) {
+        return filePaths[0]
     }
-
     let result = filePaths.sort().map(filePath => {
         if (!filePath) {
             return ''
@@ -100,6 +103,22 @@ function mergeFiles(filePaths) {
     filePaths.forEach((filePath) => {
         fs.unlinkSync(filePath)
     })
+    return mergedFilePath
+}
+
+function postprocessingFiles(filePaths) {
+    filePaths.forEach((filePath) => {
+        if (!filePath || filePath == '') {
+            return
+        }
+        var content = fs.readFileSync(filePath, { encoding: 'utf8' })
+        // handle enumeratorTypeNames
+        enumeratorTypeNames.forEach(type => {
+            const keyword = type + '.fromPointer(result)'
+            content = content.replace(keyword, 'result.address')
+        })
+        fs.writeFileSync(filePath, content)
+    })
 }
 
 function formatDartFile(dartPath) {
@@ -161,7 +180,9 @@ function generateDartWithWorker(content, path, script) {
         }
 
         let dartFilePath = writeOutputToFileByPath(result.dartCode, path)
-
+        // collect all enumeratorTypeNames
+        result.enumeratorTypeNames.forEach(item => enumeratorTypeNames.push(item))
+        // collect all packages
         if (projectName) {
             result.packages.forEach(item => packageSet.add(item))
         }
@@ -201,10 +222,10 @@ async function runWorkItems(workItems) {
         })
         return Promise.all(ps).then((results) => {
             // merge files
-            mergeFiles(results.filter((f) => f != undefined))
+            return mergeFiles(results.filter((f) => f != undefined))
         })
     })
-    await Promise.all(promises)
+    return await Promise.all(promises)
 }
 
 function checkTemplateValid(template) {
@@ -260,7 +281,8 @@ export async function main(input, options, onMainThread = false) {
             workItems.set(file, script)
         })
     })
-    await runWorkItems(workItems)
+    const filePaths = await runWorkItems(workItems)
+    postprocessingFiles(filePaths)
 
     outputDir = baseOutputDir
     formatDartFile(outputDir)

lib/objc/DNObjectiveCContext.js

@@ -1,6 +1,14 @@
 import DNObjectiveCTypeConverter from './DNObjectiveCTypeConverter.js'
 import { rawGenericType, convertMutableTypeIfNeed } from '../common/utils.js'
 
+export class DNResult {
+    constructor(dartCode, packages, enumeratorTypeNames) {
+        this.dartCode = dartCode
+        this.packages = packages
+        this.enumeratorTypeNames = enumeratorTypeNames
+    }
+}
+
 export class DNContext {
     constructor(internal) {
         this.internal = internal
@@ -81,14 +89,12 @@ export class DNBlockDefContext extends DNContext {
     parse() {
         var argList = ''
         this.args.forEach((element, index) => {
-            if (index == this.args.length - 1) {
-                argList += element.type + ' ' + element.name
-            } else {
-                argList += element.type + ' ' + element.name + ', '
+            argList += element.type + '? ' + element.name
+            if (index != this.args.length - 1) {
+                argList += ', '
             }
         })
-        var result = 'typedef '
-        result += this.returnType + ' ' + this.defName + '(' + argList + ');'
+        const result = 'typedef ' + this.defName + ' = ' + this.returnType + '? Function(' + argList + ');'
         return result
     }
 }
@@ -107,8 +113,7 @@ export class DNEnumItemContext extends DNContext {
         var result = this.availability.map((a) => a.parse()).join(' ') + '\n'
         this.value = this.value.toString().replace('UL','')
         if (this.type) {
-            result += 'const ' + this.type + ' ' + this.name + ' = ' +
-                this.type + '(' + this.value + ');\n'
+            result += 'const ' + this.type + ' ' + this.name + ' = ' + this.value + ';\n'
         } else {
             result += 'const int ' + this.name + ' = ' + this.value + ';\n'
         }
@@ -132,15 +137,12 @@ export class DNEnumDefContext extends DNContext {
         var result = '\n'
         if (this.defName) {
             var availability = this.availability.map((a) => a.parse()).join(' ') + '\n'
-            var superClass = 'NSEnum'
+            var aliasType = 'NSEnum'
             if (this.type == 'NS_OPTIONS') {
-                superClass = 'NSOptions'
+                aliasType = 'NSOptions'
             }
             result += availability +
-                'class ' + this.defName + ' extends ' + superClass + ' {\n' +
-                '  const ' + this.defName + '(dynamic raw) : super(raw);\n' +
-                '  ' + this.defName + '.fromPointer(Pointer<Void> ptr) : super(ptr.address);\n' +
-                '}\n\n'
+                'typedef ' + this.defName + ' = ' + aliasType + ';\n\n'
         }
 
         for (const key in this.enumMap) {
@@ -475,7 +477,7 @@ export class DNClassContext extends DNContext {
             result += ' with ' + this.protocols.join(',')
         }
         result += ' {\n'
-        result += '  ' + this.name + '([Class isa]) : super(isa ?? Class(\'' + this.name + '\'));\n'
+        result += '  ' + this.name + '([Class? isa]) : super(isa ?? Class(\'' + this.name + '\'));\n'
         result += '  ' + this.name + '.fromPointer(Pointer<Void> ptr) : super.fromPointer(ptr);\n'
         this.properties.forEach(element => {
             var parseRet = element.parse()
@@ -589,10 +591,11 @@ export class DNImportContext extends DNContext {
 }
 
 export class DNRootContext extends DNContext {
-    constructor(internal, needExport, isPartOfFile = false) {
+    constructor(internal, needExport, isPartOfFile = false, enumeratorTypeNames = []) {
         super(internal)
         this.needExport = needExport
         this.isPartOfFile = isPartOfFile
+        this.enumeratorTypeNames = enumeratorTypeNames
     }
 
     parse() {
@@ -617,10 +620,7 @@ export class DNRootContext extends DNContext {
             }
             return childResult
         }).join('\n')
-        return {
-            dartCode: result,
-            packages: packageSet
-        }
+        return new DNResult(result, packageSet, this.enumeratorTypeNames)
     }
 }
 

lib/objc/DNObjectiveCParserListener.js

@@ -14,9 +14,9 @@ export default class DNObjectiveCParserListener extends ObjectiveCParserListener
         this.isPartOfFile = isPartOfFile
     }
 
-    buildDart() {
-        var dart = this.rootContext.parse()
-        this.cb(dart, null)
+    buildResult() {
+        var result = this.rootContext.parse()
+        this.cb(result, null)
     }
 
     // Enter a parse tree produced by ObjectiveCParser#translationUnit.
@@ -37,7 +37,7 @@ export default class DNObjectiveCParserListener extends ObjectiveCParserListener
     }
     // Exit a parse tree produced by ObjectiveCParser#translationUnit.
     exitTranslationUnit(ctx) {
-        this.buildDart()
+        this.buildResult()
     }
     // Enter a parse tree produced by ObjectiveCParser#topLevelDeclaration.
     enterTopLevelDeclaration(ctx) {
@@ -584,6 +584,8 @@ export default class DNObjectiveCParserListener extends ObjectiveCParserListener
     }
     // Exit a parse tree produced by ObjectiveCParser#enumDeclaration.
     exitEnumDeclaration(ctx) {
+        // Add Enumerator to global array for postprocessing.
+        this.rootContext.enumeratorTypeNames.push(this.currentContext.defName)
         this.currentContext = this.currentContext.parent
     }
     // Enter a parse tree produced by ObjectiveCParser#varDeclaration.
@@ -729,11 +731,10 @@ export default class DNObjectiveCParserListener extends ObjectiveCParserListener
                 returnType = this.currentContext.parent.name
             }
             this.currentContext.returnType = TC.convert(returnType)
-            // FIXME: pointer to struct
-            /// Both CString and NSString can be converted to Dart String. 
-            /// But converting CString to Dart String is under auto encoding,
-            /// which doesn't need call `fromPointer`.
-            var isDartPointerType =!DNObjectiveCTypeConverter.basicAutoConvertReturnTypes.includes(this.currentContext.returnType) && 
+            /// FIXME: pointer to struct
+            /// Both CString and NSString can be converted to Dart String automatically, 
+            /// those don't need call `fromPointer`.
+            var isDartPointerType = !DNObjectiveCTypeConverter.basicAutoConvertReturnTypes.includes(this.currentContext.returnType) && 
                 (!DNObjectiveCTypeConverter.ObjcBasicType.includes(returnType) || (pointer != null && returnType != 'char *'));                   
             this.currentContext.callFromPointer = isDartPointerType
         } else if (this.currentContext instanceof DNArgumentContext) {
@@ -759,10 +760,9 @@ export default class DNObjectiveCParserListener extends ObjectiveCParserListener
                 }
                 this.currentContext.type = TC.convert(type)
             }
-            // FIXME: pointer to struct
-            /// Both CString and NSString can be converted to Dart String. 
-            /// But converting CString to Dart String is under auto encoding,
-            /// which doesn't need call `fromPointer`.
+            /// FIXME: pointer to struct
+            /// Both CString and NSString can be converted to Dart String automatically, 
+            /// those don't need call `fromPointer`.
             this.currentContext.isDartPointerType = !DNObjectiveCTypeConverter.basicAutoConvertReturnTypes.includes(this.currentContext.type) &&
                 (!DNObjectiveCTypeConverter.ObjcBasicType.includes(type) || (pointer != null && type != 'char *'));   
         }

lib/objc/DNObjectiveCTypeConverter.js

@@ -8,7 +8,7 @@ export default class DNObjectiveCTypeConverter {
 
     convert(objcType, isTypeInBlock = false) {
         var result = objcType
-        //basic type not need to remove * symbol
+        // basic type not need to remove * symbol
         if (!DNObjectiveCTypeConverter.ObjcBasicType.includes(result)) {
             result = result.replace(/\s+\*+/g,"")
         }
@@ -47,6 +47,7 @@ DNObjectiveCTypeConverter.DNOCBuiltinTypeToDartMap = {
     'NSArray': 'List',
     'NSDictionary': 'Map',
     'NSSet': 'Set',
+    'NSString': 'String',
 }
 
 DNObjectiveCTypeConverter.DNOCBlockTypeToDartMap = {
@@ -61,10 +62,12 @@ DNObjectiveCTypeConverter.basicAutoConvertReturnTypes = [
     'double',
     'bool',
     'CString',
+    'String',
     'Pointer<Void>',
     // TODO: built-in Structs
 ]
 
+// Objective-C basic type will not remove * symbol
 DNObjectiveCTypeConverter.ObjcBasicType = [
     'void',
     'void *',
@@ -94,7 +97,7 @@ DNObjectiveCTypeConverter.ObjcBasicType = [
     'CGFloat',
     'BOOL',
     'bool',
-    '_Bool'
+    '_Bool',
 ]
 
 //ignore mutable type

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dartnative/codegen",
-  "version": "1.2.2",
+  "version": "2.0.0",
   "type": "module",
   "description": "Code generator for dart_native.",
   "main": "index.js",

test/objc/RuntimeStub.h

@@ -9,10 +9,9 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-typedef NS_OPTIONS(NSUInteger, TestOptions) {
-    TestOptionsNone = 0,
-    TestOptionsOne = 1 << 0,
-    TestOptionsTwo = 1 << 1,
+typedef NS_OPTIONS(NSUInteger, ItemIndex) { ItemIndexNone = 0,
+                                              ItemIndexOne = 1 << 0,
+                                              ItemIndexTwo = 1 << 1,
 };
 
 @protocol SampleDelegate
@@ -22,9 +21,10 @@ typedef NS_OPTIONS(NSUInteger, TestOptions) {
 
 @end
 
-typedef NSObject * _Nonnull (^BarBlock)(NSObject *a);
+typedef NSObject *_Nonnull (^BarBlock)(NSObject *a);
 typedef CGAffineTransform (^StretBlock)(CGAffineTransform a);
-typedef char * _Nonnull (^CStringRetBlock)(char *a);
+typedef char *_Nonnull (^CStringRetBlock)(char *a);
+typedef NSDictionary *_Nonnull (^NSDictionaryRetBlock)(NSDictionary *a);
 typedef CGFloat (^CGFloatRetBlock)(CGFloat a);
 
 @interface RuntimeStub : NSObject
@@ -56,6 +56,7 @@ typedef CGFloat (^CGFloatRetBlock)(CGFloat a);
 - (NSDirectionalEdgeInsets)fooNSDirectionalEdgeInsets:(NSDirectionalEdgeInsets)insets
     API_AVAILABLE(ios(11.0));
 - (CGAffineTransform)fooCGAffineTransform:(CGAffineTransform)transform;
+- (CATransform3D)fooCATransform3D:(CATransform3D)transform3D;
 - (NSArray *)fooNSArray:(NSArray *)array;
 - (NSMutableArray *)fooNSMutableArray:(NSMutableArray *)array;
 - (NSDictionary *)fooNSDictionary:(NSDictionary *)dict;
@@ -64,14 +65,15 @@ typedef CGFloat (^CGFloatRetBlock)(CGFloat a);
 - (NSMutableSet *)fooNSMutableSet:(NSMutableSet *)set;
 - (void)fooBlock:(BarBlock)block;
 - (void)fooStretBlock:(StretBlock)block;
+- (void)fooCompletion:(void (^)(void))block;
 - (void)fooCStringBlock:(CStringRetBlock)block;
-- (void)fooCompletion:(void(^)(void))block;
+- (void)fooNSDictionaryBlock:(NSDictionaryRetBlock)block;
 - (void)fooDelegate:(id<SampleDelegate>)delegate;
 - (void)fooStructDelegate:(id<SampleDelegate>)delegate;
 - (NSString *)fooNSString:(NSString *)str;
 - (NSMutableString *)fooNSMutableString:(NSMutableString *)str;
-- (void)fooWithError:(out NSError **)error;
-- (TestOptions)fooWithOptions:(TestOptions)options;
+- (BOOL)fooWithError:(out NSError **)error;
+- (ItemIndex)fooWithOptions:(ItemIndex)options;
 
 @end