| // Copyright 2013 The Flutter Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| import 'ast.dart'; |
| import 'functional.dart'; |
| import 'generator.dart'; |
| import 'generator_tools.dart'; |
| import 'pigeon_lib.dart' show Error, TaskQueueType; |
| |
| /// Documentation comment open symbol. |
| const String _docCommentPrefix = '///'; |
| |
| /// Documentation comment spec. |
| const DocumentCommentSpecification _docCommentSpec = |
| DocumentCommentSpecification(_docCommentPrefix); |
| |
| /// Options that control how Objective-C code will be generated. |
| class ObjcOptions { |
| /// Parametric constructor for ObjcOptions. |
| const ObjcOptions({ |
| this.headerIncludePath, |
| this.prefix, |
| this.copyrightHeader, |
| }); |
| |
| /// The path to the header that will get placed in the source filed (example: |
| /// "foo.h"). |
| final String? headerIncludePath; |
| |
| /// Prefix that will be appended before all generated classes and protocols. |
| final String? prefix; |
| |
| /// A copyright header that will get prepended to generated code. |
| final Iterable<String>? copyrightHeader; |
| |
| /// Creates a [ObjcOptions] from a Map representation where: |
| /// `x = ObjcOptions.fromMap(x.toMap())`. |
| static ObjcOptions fromMap(Map<String, Object> map) { |
| final Iterable<dynamic>? copyrightHeader = |
| map['copyrightHeader'] as Iterable<dynamic>?; |
| return ObjcOptions( |
| headerIncludePath: map['header'] as String?, |
| prefix: map['prefix'] as String?, |
| copyrightHeader: copyrightHeader?.cast<String>(), |
| ); |
| } |
| |
| /// Converts a [ObjcOptions] to a Map representation where: |
| /// `x = ObjcOptions.fromMap(x.toMap())`. |
| Map<String, Object> toMap() { |
| final Map<String, Object> result = <String, Object>{ |
| if (headerIncludePath != null) 'header': headerIncludePath!, |
| if (prefix != null) 'prefix': prefix!, |
| if (copyrightHeader != null) 'copyrightHeader': copyrightHeader!, |
| }; |
| return result; |
| } |
| |
| /// Overrides any non-null parameters from [options] into this to make a new |
| /// [ObjcOptions]. |
| ObjcOptions merge(ObjcOptions options) { |
| return ObjcOptions.fromMap(mergeMaps(toMap(), options.toMap())); |
| } |
| } |
| |
| /// Class that manages all Objc code generation. |
| class ObjcGenerator extends Generator<OutputFileOptions<ObjcOptions>> { |
| /// Instantiates a Objc Generator. |
| const ObjcGenerator(); |
| |
| /// Generates Objc file of type specified in [generatorOptions] |
| @override |
| void generate(OutputFileOptions<ObjcOptions> generatorOptions, Root root, |
| StringSink sink) { |
| if (generatorOptions.fileType == FileType.header) { |
| const ObjcHeaderGenerator() |
| .generate(generatorOptions.languageOptions, root, sink); |
| } else if (generatorOptions.fileType == FileType.source) { |
| const ObjcSourceGenerator() |
| .generate(generatorOptions.languageOptions, root, sink); |
| } |
| } |
| } |
| |
| /// Generates Objc .h file. |
| class ObjcHeaderGenerator extends StructuredGenerator<ObjcOptions> { |
| /// Constructor. |
| const ObjcHeaderGenerator(); |
| |
| @override |
| void writeFilePrologue( |
| ObjcOptions generatorOptions, Root root, Indent indent) { |
| if (generatorOptions.copyrightHeader != null) { |
| addLines(indent, generatorOptions.copyrightHeader!, linePrefix: '// '); |
| } |
| indent.writeln('// $generatedCodeWarning'); |
| indent.writeln('// $seeAlsoWarning'); |
| indent.newln(); |
| } |
| |
| @override |
| void writeFileImports( |
| ObjcOptions generatorOptions, Root root, Indent indent) { |
| indent.writeln('#import <Foundation/Foundation.h>'); |
| indent.newln(); |
| |
| indent.writeln('@protocol FlutterBinaryMessenger;'); |
| indent.writeln('@protocol FlutterMessageCodec;'); |
| indent.writeln('@class FlutterError;'); |
| indent.writeln('@class FlutterStandardTypedData;'); |
| indent.newln(); |
| indent.writeln('NS_ASSUME_NONNULL_BEGIN'); |
| } |
| |
| @override |
| void writeEnum( |
| ObjcOptions generatorOptions, Root root, Indent indent, Enum anEnum) { |
| final String enumName = _className(generatorOptions.prefix, anEnum.name); |
| indent.newln(); |
| addDocumentationComments( |
| indent, anEnum.documentationComments, _docCommentSpec); |
| |
| indent.write('typedef NS_ENUM(NSUInteger, $enumName) '); |
| indent.addScoped('{', '};', () { |
| enumerate(anEnum.members, (int index, final EnumMember member) { |
| addDocumentationComments( |
| indent, member.documentationComments, _docCommentSpec); |
| // Capitalized first letter to ensure Swift compatibility |
| indent.writeln( |
| '$enumName${member.name[0].toUpperCase()}${member.name.substring(1)} = $index,'); |
| }); |
| }); |
| } |
| |
| @override |
| void writeDataClasses( |
| ObjcOptions generatorOptions, Root root, Indent indent) { |
| indent.newln(); |
| for (final Class klass in root.classes) { |
| indent.writeln( |
| '@class ${_className(generatorOptions.prefix, klass.name)};'); |
| } |
| indent.newln(); |
| super.writeDataClasses(generatorOptions, root, indent); |
| } |
| |
| @override |
| void writeDataClass( |
| ObjcOptions generatorOptions, Root root, Indent indent, Class klass) { |
| final List<Class> classes = root.classes; |
| final List<Enum> enums = root.enums; |
| final String? prefix = generatorOptions.prefix; |
| final List<String> customEnumNames = enums.map((Enum x) => x.name).toList(); |
| |
| addDocumentationComments( |
| indent, klass.documentationComments, _docCommentSpec); |
| |
| indent.writeln('@interface ${_className(prefix, klass.name)} : NSObject'); |
| if (getFieldsInSerializationOrder(klass).isNotEmpty) { |
| if (getFieldsInSerializationOrder(klass) |
| .map((NamedType e) => !e.type.isNullable) |
| .any((bool e) => e)) { |
| indent.writeln( |
| '$_docCommentPrefix `init` unavailable to enforce nonnull fields, see the `make` class method.'); |
| indent.writeln('- (instancetype)init NS_UNAVAILABLE;'); |
| } |
| _writeObjcSourceClassInitializerDeclaration( |
| indent, klass, classes, enums, prefix); |
| indent.addln(';'); |
| } |
| for (final NamedType field in getFieldsInSerializationOrder(klass)) { |
| final HostDatatype hostDatatype = getFieldHostDatatype( |
| field, |
| classes, |
| enums, |
| (TypeDeclaration x) => _objcTypePtrForPrimitiveDartType(prefix, x), |
| customResolver: customEnumNames.contains(field.type.baseName) |
| ? (String x) => _className(prefix, x) |
| : (String x) => '${_className(prefix, x)} *'); |
| late final String propertyType; |
| addDocumentationComments( |
| indent, field.documentationComments, _docCommentSpec); |
| if (customEnumNames.contains(field.type.baseName)) { |
| propertyType = 'assign'; |
| } else { |
| propertyType = _propertyTypeForDartType(field); |
| } |
| final String nullability = |
| _isNullable(hostDatatype, field.type) ? ', nullable' : ''; |
| indent.writeln( |
| '@property(nonatomic, $propertyType$nullability) ${hostDatatype.datatype} ${field.name};'); |
| } |
| indent.writeln('@end'); |
| indent.newln(); |
| } |
| |
| @override |
| void writeClassEncode( |
| ObjcOptions generatorOptions, |
| Root root, |
| Indent indent, |
| Class klass, |
| Set<String> customClassNames, |
| Set<String> customEnumNames, |
| ) {} |
| |
| @override |
| void writeClassDecode( |
| ObjcOptions generatorOptions, |
| Root root, |
| Indent indent, |
| Class klass, |
| Set<String> customClassNames, |
| Set<String> customEnumNames, |
| ) {} |
| |
| @override |
| void writeApis(ObjcOptions generatorOptions, Root root, Indent indent) { |
| super.writeApis(generatorOptions, root, indent); |
| indent.writeln('NS_ASSUME_NONNULL_END'); |
| } |
| |
| @override |
| void writeFlutterApi( |
| ObjcOptions generatorOptions, |
| Root root, |
| Indent indent, |
| Api api, |
| ) { |
| indent.writeln( |
| '$_docCommentPrefix The codec used by ${_className(generatorOptions.prefix, api.name)}.'); |
| indent.writeln( |
| 'NSObject<FlutterMessageCodec> *${_getCodecGetterName(generatorOptions.prefix, api.name)}(void);'); |
| indent.newln(); |
| final String apiName = _className(generatorOptions.prefix, api.name); |
| addDocumentationComments( |
| indent, api.documentationComments, _docCommentSpec); |
| |
| indent.writeln('@interface $apiName : NSObject'); |
| indent.writeln( |
| '- (instancetype)initWithBinaryMessenger:(id<FlutterBinaryMessenger>)binaryMessenger;'); |
| for (final Method func in api.methods) { |
| final _ObjcPtr returnType = |
| _objcTypeForDartType(generatorOptions.prefix, func.returnType); |
| final String callbackType = _callbackForType(func.returnType, returnType); |
| addDocumentationComments( |
| indent, func.documentationComments, _docCommentSpec); |
| |
| indent.writeln('${_makeObjcSignature( |
| func: func, |
| options: generatorOptions, |
| returnType: 'void', |
| lastArgName: 'completion', |
| lastArgType: callbackType, |
| isEnum: (TypeDeclaration t) => isEnum(root, t), |
| )};'); |
| } |
| indent.writeln('@end'); |
| indent.newln(); |
| } |
| |
| @override |
| void writeHostApi( |
| ObjcOptions generatorOptions, |
| Root root, |
| Indent indent, |
| Api api, |
| ) { |
| indent.writeln( |
| '$_docCommentPrefix The codec used by ${_className(generatorOptions.prefix, api.name)}.'); |
| indent.writeln( |
| 'NSObject<FlutterMessageCodec> *${_getCodecGetterName(generatorOptions.prefix, api.name)}(void);'); |
| indent.newln(); |
| final String apiName = _className(generatorOptions.prefix, api.name); |
| addDocumentationComments( |
| indent, api.documentationComments, _docCommentSpec); |
| |
| indent.writeln('@protocol $apiName'); |
| for (final Method func in api.methods) { |
| final _ObjcPtr returnTypeName = |
| _objcTypeForDartType(generatorOptions.prefix, func.returnType); |
| |
| String? lastArgName; |
| String? lastArgType; |
| String? returnType; |
| if (func.isAsynchronous) { |
| returnType = 'void'; |
| if (func.returnType.isVoid) { |
| lastArgType = 'void (^)(FlutterError *_Nullable)'; |
| lastArgName = 'completion'; |
| } else { |
| lastArgType = |
| 'void (^)(${returnTypeName.ptr}_Nullable, FlutterError *_Nullable)'; |
| lastArgName = 'completion'; |
| } |
| } else { |
| returnType = func.returnType.isVoid |
| ? 'void' |
| : 'nullable ${returnTypeName.ptr.trim()}'; |
| lastArgType = 'FlutterError *_Nullable *_Nonnull'; |
| lastArgName = 'error'; |
| } |
| final List<String> generatorComments = <String>[]; |
| if (!func.returnType.isNullable && |
| !func.returnType.isVoid && |
| !func.isAsynchronous) { |
| generatorComments.add(' @return `nil` only when `error != nil`.'); |
| } |
| addDocumentationComments( |
| indent, func.documentationComments, _docCommentSpec, |
| generatorComments: generatorComments); |
| |
| final String signature = _makeObjcSignature( |
| func: func, |
| options: generatorOptions, |
| returnType: returnType, |
| lastArgName: lastArgName, |
| lastArgType: lastArgType, |
| isEnum: (TypeDeclaration t) => isEnum(root, t), |
| ); |
| indent.writeln('$signature;'); |
| } |
| indent.writeln('@end'); |
| indent.newln(); |
| indent.writeln( |
| 'extern void ${apiName}Setup(id<FlutterBinaryMessenger> binaryMessenger, NSObject<$apiName> *_Nullable api);'); |
| indent.newln(); |
| } |
| } |
| |
| /// Generates Objc .m file. |
| class ObjcSourceGenerator extends StructuredGenerator<ObjcOptions> { |
| /// Constructor. |
| const ObjcSourceGenerator(); |
| |
| @override |
| void writeFilePrologue( |
| ObjcOptions generatorOptions, Root root, Indent indent) { |
| if (generatorOptions.copyrightHeader != null) { |
| addLines(indent, generatorOptions.copyrightHeader!, linePrefix: '// '); |
| } |
| indent.writeln('// $generatedCodeWarning'); |
| indent.writeln('// $seeAlsoWarning'); |
| indent.newln(); |
| } |
| |
| @override |
| void writeFileImports( |
| ObjcOptions generatorOptions, Root root, Indent indent) { |
| indent.writeln('#import "${generatorOptions.headerIncludePath}"'); |
| indent.writeln('#import <Flutter/Flutter.h>'); |
| indent.newln(); |
| |
| indent.writeln('#if !__has_feature(objc_arc)'); |
| indent.writeln('#error File requires ARC to be enabled.'); |
| indent.writeln('#endif'); |
| indent.newln(); |
| } |
| |
| @override |
| void writeDataClasses( |
| ObjcOptions generatorOptions, Root root, Indent indent) { |
| _writeObjcSourceHelperFunctions(indent); |
| |
| for (final Class klass in root.classes) { |
| _writeObjcSourceDataClassExtension(generatorOptions, indent, klass); |
| } |
| indent.newln(); |
| super.writeDataClasses(generatorOptions, root, indent); |
| } |
| |
| @override |
| void writeDataClass( |
| ObjcOptions generatorOptions, Root root, Indent indent, Class klass) { |
| final Set<String> customClassNames = |
| root.classes.map((Class x) => x.name).toSet(); |
| final Set<String> customEnumNames = |
| root.enums.map((Enum x) => x.name).toSet(); |
| final String className = _className(generatorOptions.prefix, klass.name); |
| |
| indent.writeln('@implementation $className'); |
| _writeObjcSourceClassInitializer(generatorOptions, root, indent, klass, |
| customClassNames, customEnumNames, className); |
| writeClassDecode(generatorOptions, root, indent, klass, customClassNames, |
| customEnumNames); |
| writeClassEncode(generatorOptions, root, indent, klass, customClassNames, |
| customEnumNames); |
| indent.writeln('@end'); |
| indent.newln(); |
| } |
| |
| @override |
| void writeClassEncode( |
| ObjcOptions generatorOptions, |
| Root root, |
| Indent indent, |
| Class klass, |
| Set<String> customClassNames, |
| Set<String> customEnumNames, |
| ) { |
| indent.write('- (NSArray *)toList '); |
| indent.addScoped('{', '}', () { |
| indent.write('return'); |
| indent.addScoped(' @[', '];', () { |
| for (final NamedType field in klass.fields) { |
| indent.writeln( |
| '${_arrayValue(customClassNames, customEnumNames, field)},'); |
| } |
| }); |
| }); |
| } |
| |
| @override |
| void writeClassDecode( |
| ObjcOptions generatorOptions, |
| Root root, |
| Indent indent, |
| Class klass, |
| Set<String> customClassNames, |
| Set<String> customEnumNames, |
| ) { |
| final String className = _className(generatorOptions.prefix, klass.name); |
| indent.write('+ ($className *)fromList:(NSArray *)list '); |
| indent.addScoped('{', '}', () { |
| const String resultName = 'pigeonResult'; |
| indent.writeln('$className *$resultName = [[$className alloc] init];'); |
| enumerate(getFieldsInSerializationOrder(klass), |
| (int index, final NamedType field) { |
| if (customEnumNames.contains(field.type.baseName)) { |
| indent.writeln( |
| '$resultName.${field.name} = [${_listGetter(customClassNames, 'list', field, index, generatorOptions.prefix)} integerValue];'); |
| } else { |
| indent.writeln( |
| '$resultName.${field.name} = ${_listGetter(customClassNames, 'list', field, index, generatorOptions.prefix)};'); |
| if (!field.type.isNullable) { |
| indent.writeln('NSAssert($resultName.${field.name} != nil, @"");'); |
| } |
| } |
| }); |
| indent.writeln('return $resultName;'); |
| }); |
| |
| indent.write('+ (nullable $className *)nullableFromList:(NSArray *)list '); |
| indent.addScoped('{', '}', () { |
| indent.writeln('return (list) ? [$className fromList:list] : nil;'); |
| }); |
| } |
| |
| void _writeCodecAndGetter( |
| ObjcOptions generatorOptions, Root root, Indent indent, Api api) { |
| final String codecName = _getCodecName(generatorOptions.prefix, api.name); |
| if (getCodecClasses(api, root).isNotEmpty) { |
| _writeCodec(indent, codecName, generatorOptions, api, root); |
| indent.newln(); |
| } |
| _writeCodecGetter(indent, codecName, generatorOptions, api, root); |
| indent.newln(); |
| } |
| |
| @override |
| void writeFlutterApi( |
| ObjcOptions generatorOptions, |
| Root root, |
| Indent indent, |
| Api api, |
| ) { |
| assert(api.location == ApiLocation.flutter); |
| final String apiName = _className(generatorOptions.prefix, api.name); |
| |
| _writeCodecAndGetter(generatorOptions, root, indent, api); |
| |
| _writeExtension(indent, apiName); |
| indent.newln(); |
| indent.writeln('@implementation $apiName'); |
| indent.newln(); |
| _writeInitializer(indent); |
| for (final Method func in api.methods) { |
| _writeMethod(generatorOptions, root, indent, api, func); |
| } |
| indent.writeln('@end'); |
| indent.newln(); |
| } |
| |
| @override |
| void writeHostApi( |
| ObjcOptions generatorOptions, |
| Root root, |
| Indent indent, |
| Api api, |
| ) { |
| assert(api.location == ApiLocation.host); |
| final String apiName = _className(generatorOptions.prefix, api.name); |
| |
| _writeCodecAndGetter(generatorOptions, root, indent, api); |
| |
| const String channelName = 'channel'; |
| indent.write( |
| 'void ${apiName}Setup(id<FlutterBinaryMessenger> binaryMessenger, NSObject<$apiName> *api) '); |
| indent.addScoped('{', '}', () { |
| for (final Method func in api.methods) { |
| addDocumentationComments( |
| indent, func.documentationComments, _docCommentSpec); |
| |
| indent.writeScoped('{', '}', () { |
| String? taskQueue; |
| if (func.taskQueueType != TaskQueueType.serial) { |
| taskQueue = 'taskQueue'; |
| indent.writeln( |
| 'NSObject<FlutterTaskQueue> *$taskQueue = [binaryMessenger makeBackgroundTaskQueue];'); |
| } |
| _writeChannelAllocation( |
| generatorOptions, indent, api, func, channelName, taskQueue); |
| indent.write('if (api) '); |
| indent.addScoped('{', '}', () { |
| _writeChannelApiBinding( |
| generatorOptions, root, indent, apiName, func, channelName); |
| }, addTrailingNewline: false); |
| indent.add(' else '); |
| indent.addScoped('{', '}', () { |
| indent.writeln('[$channelName setMessageHandler:nil];'); |
| }); |
| }); |
| } |
| }); |
| } |
| |
| void _writeChannelApiBinding(ObjcOptions generatorOptions, Root root, |
| Indent indent, String apiName, Method func, String channel) { |
| void unpackArgs(String variable, Iterable<String> argNames) { |
| indent.writeln('NSArray *args = $variable;'); |
| map3(wholeNumbers.take(func.arguments.length), argNames, func.arguments, |
| (int count, String argName, NamedType arg) { |
| if (isEnum(root, arg.type)) { |
| return '${_className(generatorOptions.prefix, arg.type.baseName)} $argName = [GetNullableObjectAtIndex(args, $count) integerValue];'; |
| } else { |
| final _ObjcPtr argType = |
| _objcTypeForDartType(generatorOptions.prefix, arg.type); |
| return '${argType.ptr}$argName = GetNullableObjectAtIndex(args, $count);'; |
| } |
| }).forEach(indent.writeln); |
| } |
| |
| void writeAsyncBindings(Iterable<String> selectorComponents, |
| String callSignature, _ObjcPtr returnType) { |
| if (func.returnType.isVoid) { |
| const String callback = 'callback(wrapResult(nil, error));'; |
| if (func.arguments.isEmpty) { |
| indent.writeScoped( |
| '[api ${selectorComponents.first}:^(FlutterError *_Nullable error) {', |
| '}];', () { |
| indent.writeln(callback); |
| }); |
| } else { |
| indent.writeScoped( |
| '[api $callSignature ${selectorComponents.last}:^(FlutterError *_Nullable error) {', |
| '}];', () { |
| indent.writeln(callback); |
| }); |
| } |
| } else { |
| const String callback = 'callback(wrapResult(output, error));'; |
| if (func.arguments.isEmpty) { |
| indent.writeScoped( |
| '[api ${selectorComponents.first}:^(${returnType.ptr}_Nullable output, FlutterError *_Nullable error) {', |
| '}];', () { |
| indent.writeln(callback); |
| }); |
| } else { |
| indent.writeScoped( |
| '[api $callSignature ${selectorComponents.last}:^(${returnType.ptr}_Nullable output, FlutterError *_Nullable error) {', |
| '}];', () { |
| indent.writeln(callback); |
| }); |
| } |
| } |
| } |
| |
| void writeSyncBindings(String call, _ObjcPtr returnType) { |
| indent.writeln('FlutterError *error;'); |
| if (func.returnType.isVoid) { |
| indent.writeln('$call;'); |
| indent.writeln('callback(wrapResult(nil, error));'); |
| } else { |
| indent.writeln('${returnType.ptr}output = $call;'); |
| indent.writeln('callback(wrapResult(output, error));'); |
| } |
| } |
| |
| // TODO(gaaclarke): Incorporate this into _getSelectorComponents. |
| final String lastSelectorComponent = |
| func.isAsynchronous ? 'completion' : 'error'; |
| final String selector = _getSelector(func, lastSelectorComponent); |
| indent.writeln( |
| 'NSCAssert([api respondsToSelector:@selector($selector)], @"$apiName api (%@) doesn\'t respond to @selector($selector)", api);'); |
| indent.write( |
| '[$channel setMessageHandler:^(id _Nullable message, FlutterReply callback) '); |
| indent.addScoped('{', '}];', () { |
| final _ObjcPtr returnType = |
| _objcTypeForDartType(generatorOptions.prefix, func.returnType); |
| final Iterable<String> selectorComponents = |
| _getSelectorComponents(func, lastSelectorComponent); |
| final Iterable<String> argNames = |
| indexMap(func.arguments, _getSafeArgName); |
| final String callSignature = |
| map2(selectorComponents.take(argNames.length), argNames, |
| (String selectorComponent, String argName) { |
| return '$selectorComponent:$argName'; |
| }).join(' '); |
| if (func.arguments.isNotEmpty) { |
| unpackArgs('message', argNames); |
| } |
| if (func.isAsynchronous) { |
| writeAsyncBindings(selectorComponents, callSignature, returnType); |
| } else { |
| final String syncCall = func.arguments.isEmpty |
| ? '[api ${selectorComponents.first}:&error]' |
| : '[api $callSignature error:&error]'; |
| writeSyncBindings(syncCall, returnType); |
| } |
| }); |
| } |
| |
| void _writeChannelAllocation(ObjcOptions generatorOptions, Indent indent, |
| Api api, Method func, String varName, String? taskQueue) { |
| indent.writeln('FlutterBasicMessageChannel *$varName ='); |
| indent.nest(1, () { |
| indent.writeln('[[FlutterBasicMessageChannel alloc]'); |
| indent.nest(1, () { |
| indent.writeln('initWithName:@"${makeChannelName(api, func)}"'); |
| indent.writeln('binaryMessenger:binaryMessenger'); |
| indent.write('codec:'); |
| indent |
| .add('${_getCodecGetterName(generatorOptions.prefix, api.name)}()'); |
| |
| if (taskQueue != null) { |
| indent.newln(); |
| indent.addln('taskQueue:$taskQueue];'); |
| } else { |
| indent.addln('];'); |
| } |
| }); |
| }); |
| } |
| |
| void _writeObjcSourceHelperFunctions(Indent indent) { |
| indent.format(''' |
| static NSArray *wrapResult(id result, FlutterError *error) { |
| \tif (error) { |
| \t\treturn @[ |
| \t\t\terror.code ?: [NSNull null], error.message ?: [NSNull null], error.details ?: [NSNull null] |
| \t\t]; |
| \t} |
| \treturn @[ result ?: [NSNull null] ]; |
| }'''); |
| indent.format(''' |
| static id GetNullableObject(NSDictionary *dict, id key) { |
| \tid result = dict[key]; |
| \treturn (result == [NSNull null]) ? nil : result; |
| } |
| static id GetNullableObjectAtIndex(NSArray *array, NSInteger key) { |
| \tid result = array[key]; |
| \treturn (result == [NSNull null]) ? nil : result; |
| }'''); |
| } |
| |
| void _writeObjcSourceDataClassExtension( |
| ObjcOptions languageOptions, Indent indent, Class klass) { |
| final String className = _className(languageOptions.prefix, klass.name); |
| indent.newln(); |
| indent.writeln('@interface $className ()'); |
| indent.writeln('+ ($className *)fromList:(NSArray *)list;'); |
| indent |
| .writeln('+ (nullable $className *)nullableFromList:(NSArray *)list;'); |
| indent.writeln('- (NSArray *)toList;'); |
| indent.writeln('@end'); |
| } |
| |
| void _writeObjcSourceClassInitializer( |
| ObjcOptions languageOptions, |
| Root root, |
| Indent indent, |
| Class klass, |
| Set<String> customClassNames, |
| Set<String> customEnumNames, |
| String className, |
| ) { |
| _writeObjcSourceClassInitializerDeclaration( |
| indent, klass, root.classes, root.enums, languageOptions.prefix); |
| indent.writeScoped(' {', '}', () { |
| const String result = 'pigeonResult'; |
| indent.writeln('$className* $result = [[$className alloc] init];'); |
| for (final NamedType field in getFieldsInSerializationOrder(klass)) { |
| indent.writeln('$result.${field.name} = ${field.name};'); |
| } |
| indent.writeln('return $result;'); |
| }); |
| } |
| |
| /// Writes the codec that will be used for encoding messages for the [api]. |
| /// |
| /// Example: |
| /// @interface FooHostApiCodecReader : FlutterStandardReader |
| /// ... |
| /// @interface FooHostApiCodecWriter : FlutterStandardWriter |
| /// ... |
| /// @interface FooHostApiCodecReaderWriter : FlutterStandardReaderWriter |
| /// ... |
| /// NSObject<FlutterMessageCodec> *FooHostApiCodecGetCodec() {...} |
| void _writeCodec( |
| Indent indent, String name, ObjcOptions options, Api api, Root root) { |
| assert(getCodecClasses(api, root).isNotEmpty); |
| final Iterable<EnumeratedClass> codecClasses = getCodecClasses(api, root); |
| final String readerWriterName = '${name}ReaderWriter'; |
| final String readerName = '${name}Reader'; |
| final String writerName = '${name}Writer'; |
| indent.writeln('@interface $readerName : FlutterStandardReader'); |
| indent.writeln('@end'); |
| indent.writeln('@implementation $readerName'); |
| indent.write('- (nullable id)readValueOfType:(UInt8)type '); |
| indent.addScoped('{', '}', () { |
| indent.write('switch (type) '); |
| indent.addScoped('{', '}', () { |
| for (final EnumeratedClass customClass in codecClasses) { |
| indent.write('case ${customClass.enumeration}: '); |
| indent.writeScoped('', '', () { |
| indent.writeln( |
| 'return [${_className(options.prefix, customClass.name)} fromList:[self readValue]];'); |
| }); |
| } |
| indent.writeln('default:'); |
| indent.nest(1, () { |
| indent.writeln('return [super readValueOfType:type];'); |
| }); |
| }); |
| }); |
| indent.writeln('@end'); |
| indent.newln(); |
| indent.writeln('@interface $writerName : FlutterStandardWriter'); |
| indent.writeln('@end'); |
| indent.writeln('@implementation $writerName'); |
| indent.write('- (void)writeValue:(id)value '); |
| indent.addScoped('{', '}', () { |
| bool firstClass = true; |
| for (final EnumeratedClass customClass in codecClasses) { |
| if (firstClass) { |
| indent.write(''); |
| firstClass = false; |
| } |
| indent.add( |
| 'if ([value isKindOfClass:[${_className(options.prefix, customClass.name)} class]]) '); |
| indent.addScoped('{', '} else ', () { |
| indent.writeln('[self writeByte:${customClass.enumeration}];'); |
| indent.writeln('[self writeValue:[value toList]];'); |
| }, addTrailingNewline: false); |
| } |
| indent.addScoped('{', '}', () { |
| indent.writeln('[super writeValue:value];'); |
| }); |
| }); |
| indent.writeln('@end'); |
| indent.newln(); |
| indent.format(''' |
| @interface $readerWriterName : FlutterStandardReaderWriter |
| @end |
| @implementation $readerWriterName |
| - (FlutterStandardWriter *)writerWithData:(NSMutableData *)data { |
| \treturn [[$writerName alloc] initWithData:data]; |
| } |
| - (FlutterStandardReader *)readerWithData:(NSData *)data { |
| \treturn [[$readerName alloc] initWithData:data]; |
| } |
| @end'''); |
| } |
| |
| void _writeCodecGetter( |
| Indent indent, String name, ObjcOptions options, Api api, Root root) { |
| final String readerWriterName = '${name}ReaderWriter'; |
| |
| indent.write( |
| 'NSObject<FlutterMessageCodec> *${_getCodecGetterName(options.prefix, api.name)}() '); |
| indent.addScoped('{', '}', () { |
| indent |
| .writeln('static FlutterStandardMessageCodec *sSharedObject = nil;'); |
| if (getCodecClasses(api, root).isNotEmpty) { |
| indent.writeln('static dispatch_once_t sPred = 0;'); |
| indent.write('dispatch_once(&sPred, ^'); |
| indent.addScoped('{', '});', () { |
| indent.writeln( |
| '$readerWriterName *readerWriter = [[$readerWriterName alloc] init];'); |
| indent.writeln( |
| 'sSharedObject = [FlutterStandardMessageCodec codecWithReaderWriter:readerWriter];'); |
| }); |
| } else { |
| indent.writeln( |
| 'sSharedObject = [FlutterStandardMessageCodec sharedInstance];'); |
| } |
| |
| indent.writeln('return sSharedObject;'); |
| }); |
| } |
| } |
| |
| /// Writes the method declaration for the initializer. |
| /// |
| /// Example '+ (instancetype)makeWithFoo:(NSString *)foo' |
| void _writeObjcSourceClassInitializerDeclaration(Indent indent, Class klass, |
| List<Class> classes, List<Enum> enums, String? prefix) { |
| final List<String> customEnumNames = enums.map((Enum x) => x.name).toList(); |
| indent.write('+ (instancetype)makeWith'); |
| bool isFirst = true; |
| indent.nest(2, () { |
| for (final NamedType field in getFieldsInSerializationOrder(klass)) { |
| final String label = isFirst ? _capitalize(field.name) : field.name; |
| final void Function(String) printer = isFirst |
| ? indent.add |
| : (String x) { |
| indent.newln(); |
| indent.write(x); |
| }; |
| isFirst = false; |
| final HostDatatype hostDatatype = getFieldHostDatatype( |
| field, |
| classes, |
| enums, |
| (TypeDeclaration x) => _objcTypePtrForPrimitiveDartType(prefix, x), |
| customResolver: customEnumNames.contains(field.type.baseName) |
| ? (String x) => _className(prefix, x) |
| : (String x) => '${_className(prefix, x)} *'); |
| final String nullable = |
| _isNullable(hostDatatype, field.type) ? 'nullable ' : ''; |
| printer('$label:($nullable${hostDatatype.datatype})${field.name}'); |
| } |
| }); |
| } |
| |
| /// Calculates the ObjC class name, possibly prefixed. |
| String _className(String? prefix, String className) { |
| if (prefix != null) { |
| return '$prefix$className'; |
| } else { |
| return className; |
| } |
| } |
| |
| /// Calculates callback block signature for for async methods. |
| String _callbackForType(TypeDeclaration type, _ObjcPtr objcType) { |
| return type.isVoid |
| ? 'void (^)(NSError *_Nullable)' |
| : 'void (^)(${objcType.ptr.trim()}_Nullable, NSError *_Nullable)'; |
| } |
| |
| /// Represents an ObjC pointer (ex 'id', 'NSString *'). |
| class _ObjcPtr { |
| const _ObjcPtr({required this.baseName}) : hasAsterisk = baseName != 'id'; |
| final String baseName; |
| final bool hasAsterisk; |
| String get ptr => '$baseName${hasAsterisk ? ' *' : ' '}'; |
| } |
| |
| /// Maps between Dart types to ObjC pointer types (ex 'String' => 'NSString *'). |
| const Map<String, _ObjcPtr> _objcTypeForDartTypeMap = <String, _ObjcPtr>{ |
| 'bool': _ObjcPtr(baseName: 'NSNumber'), |
| 'int': _ObjcPtr(baseName: 'NSNumber'), |
| 'String': _ObjcPtr(baseName: 'NSString'), |
| 'double': _ObjcPtr(baseName: 'NSNumber'), |
| 'Uint8List': _ObjcPtr(baseName: 'FlutterStandardTypedData'), |
| 'Int32List': _ObjcPtr(baseName: 'FlutterStandardTypedData'), |
| 'Int64List': _ObjcPtr(baseName: 'FlutterStandardTypedData'), |
| 'Float64List': _ObjcPtr(baseName: 'FlutterStandardTypedData'), |
| 'List': _ObjcPtr(baseName: 'NSArray'), |
| 'Map': _ObjcPtr(baseName: 'NSDictionary'), |
| 'Object': _ObjcPtr(baseName: 'id'), |
| }; |
| |
| /// Converts list of [TypeDeclaration] to a code string representing the type |
| /// arguments for use in generics. |
| /// Example: ('FOO', ['Foo', 'Bar']) -> 'FOOFoo *, FOOBar *'). |
| String _flattenTypeArguments(String? classPrefix, List<TypeDeclaration> args) { |
| final String result = args |
| .map<String>((TypeDeclaration e) => |
| _objcTypeForDartType(classPrefix, e).ptr.trim()) |
| .join(', '); |
| return result; |
| } |
| |
| String? _objcTypePtrForPrimitiveDartType( |
| String? classPrefix, TypeDeclaration type) { |
| return _objcTypeForDartTypeMap.containsKey(type.baseName) |
| ? _objcTypeForDartType(classPrefix, type).ptr |
| : null; |
| } |
| |
| /// Returns the objc type for a dart [type], prepending the [classPrefix] for |
| /// generated classes. For example: |
| /// _objcTypeForDartType(null, 'int') => 'NSNumber'. |
| _ObjcPtr _objcTypeForDartType(String? classPrefix, TypeDeclaration field) { |
| return _objcTypeForDartTypeMap.containsKey(field.baseName) |
| ? field.typeArguments.isEmpty |
| ? _objcTypeForDartTypeMap[field.baseName]! |
| : _ObjcPtr( |
| baseName: |
| '${_objcTypeForDartTypeMap[field.baseName]!.baseName}<${_flattenTypeArguments(classPrefix, field.typeArguments)}>') |
| : _ObjcPtr(baseName: _className(classPrefix, field.baseName)); |
| } |
| |
| /// Maps a type to a properties memory semantics (ie strong, copy). |
| String _propertyTypeForDartType(NamedType field) { |
| const Map<String, String> propertyTypeForDartTypeMap = <String, String>{ |
| 'String': 'copy', |
| 'bool': 'strong', |
| 'int': 'strong', |
| 'double': 'strong', |
| 'Uint8List': 'strong', |
| 'Int32List': 'strong', |
| 'Int64List': 'strong', |
| 'Float64List': 'strong', |
| 'List': 'strong', |
| 'Map': 'strong', |
| }; |
| |
| final String? result = propertyTypeForDartTypeMap[field.type.baseName]; |
| if (result == null) { |
| return 'strong'; |
| } else { |
| return result; |
| } |
| } |
| |
| bool _isNullable(HostDatatype hostDatatype, TypeDeclaration type) => |
| hostDatatype.datatype.contains('*') && type.isNullable; |
| |
| /// Generates the name of the codec that will be generated. |
| String _getCodecName(String? prefix, String className) => |
| '${_className(prefix, className)}Codec'; |
| |
| /// Generates the name of the function for accessing the codec instance used by |
| /// the api class named [className]. |
| String _getCodecGetterName(String? prefix, String className) => |
| '${_className(prefix, className)}GetCodec'; |
| |
| String _capitalize(String str) => |
| (str.isEmpty) ? '' : str[0].toUpperCase() + str.substring(1); |
| |
| /// Returns the components of the objc selector that will be generated from |
| /// [func], ie the strings between the semicolons. [lastSelectorComponent] is |
| /// the last component of the selector aka the label of the last parameter which |
| /// isn't included in [func]. |
| /// Example: |
| /// f('void add(int x, int y)', 'count') -> ['addX', 'y', 'count'] |
| Iterable<String> _getSelectorComponents( |
| Method func, String lastSelectorComponent) sync* { |
| if (func.objcSelector.isEmpty) { |
| final Iterator<NamedType> it = func.arguments.iterator; |
| final bool hasArguments = it.moveNext(); |
| final String namePostfix = |
| (lastSelectorComponent.isNotEmpty && func.arguments.isEmpty) |
| ? 'With${_capitalize(lastSelectorComponent)}' |
| : ''; |
| yield '${func.name}${hasArguments ? _capitalize(func.arguments[0].name) : namePostfix}'; |
| while (it.moveNext()) { |
| yield it.current.name; |
| } |
| } else { |
| assert(':'.allMatches(func.objcSelector).length == func.arguments.length); |
| final Iterable<String> customComponents = func.objcSelector |
| .split(':') |
| .where((String element) => element.isNotEmpty); |
| yield* customComponents; |
| } |
| if (lastSelectorComponent.isNotEmpty && func.arguments.isNotEmpty) { |
| yield lastSelectorComponent; |
| } |
| } |
| |
| /// Generates the objc source code method signature for [func]. [returnType] is |
| /// the return value of method, this may not match the return value in [func] |
| /// since [func] may be asynchronous. The function requires you specify a |
| /// [lastArgType] and [lastArgName] for arguments that aren't represented in |
| /// [func]. This is typically used for passing in 'error' or 'completion' |
| /// arguments that don't exist in the pigeon file but are required in the objc |
| /// output. [argNameFunc] is the function used to generate the argument name |
| /// [func.arguments]. |
| String _makeObjcSignature({ |
| required Method func, |
| required ObjcOptions options, |
| required String returnType, |
| required String lastArgType, |
| required String lastArgName, |
| required bool Function(TypeDeclaration) isEnum, |
| String Function(int, NamedType)? argNameFunc, |
| }) { |
| argNameFunc = argNameFunc ?? (int _, NamedType e) => e.name; |
| final Iterable<String> argNames = |
| followedByOne(indexMap(func.arguments, argNameFunc), lastArgName); |
| final Iterable<String> selectorComponents = |
| _getSelectorComponents(func, lastArgName); |
| final Iterable<String> argTypes = followedByOne( |
| func.arguments.map((NamedType arg) { |
| if (isEnum(arg.type)) { |
| return _className(options.prefix, arg.type.baseName); |
| } else { |
| final String nullable = arg.type.isNullable ? 'nullable ' : ''; |
| final _ObjcPtr argType = _objcTypeForDartType(options.prefix, arg.type); |
| return '$nullable${argType.ptr.trim()}'; |
| } |
| }), |
| lastArgType, |
| ); |
| |
| final String argSignature = map3( |
| selectorComponents, |
| argTypes, |
| argNames, |
| (String component, String argType, String argName) => |
| '$component:($argType)$argName', |
| ).join(' '); |
| return '- ($returnType)$argSignature'; |
| } |
| |
| /// Generates the ".h" file for the AST represented by [root] to [sink] with the |
| /// provided [options]. |
| void generateObjcHeader(ObjcOptions options, Root root, Indent indent) {} |
| |
| String _listGetter(Set<String> customClassNames, String list, NamedType field, |
| int index, String? prefix) { |
| if (customClassNames.contains(field.type.baseName)) { |
| String className = field.type.baseName; |
| if (prefix != null) { |
| className = '$prefix$className'; |
| } |
| return '[$className nullableFromList:(GetNullableObjectAtIndex($list, $index))]'; |
| } else { |
| return 'GetNullableObjectAtIndex($list, $index)'; |
| } |
| } |
| |
| String _arrayValue(Set<String> customClassNames, Set<String> customEnumNames, |
| NamedType field) { |
| if (customClassNames.contains(field.type.baseName)) { |
| return '(self.${field.name} ? [self.${field.name} toList] : [NSNull null])'; |
| } else if (customEnumNames.contains(field.type.baseName)) { |
| return '@(self.${field.name})'; |
| } else { |
| return '(self.${field.name} ?: [NSNull null])'; |
| } |
| } |
| |
| String _getSelector(Method func, String lastSelectorComponent) => |
| '${_getSelectorComponents(func, lastSelectorComponent).join(':')}:'; |
| |
| /// Returns an argument name that can be used in a context where it is possible to collide. |
| String _getSafeArgName(int count, NamedType arg) => |
| arg.name.isEmpty ? 'arg$count' : 'arg_${arg.name}'; |
| |
| void _writeExtension(Indent indent, String apiName) { |
| indent.writeln('@interface $apiName ()'); |
| indent.writeln( |
| '@property(nonatomic, strong) NSObject<FlutterBinaryMessenger> *binaryMessenger;'); |
| indent.writeln('@end'); |
| } |
| |
| void _writeInitializer(Indent indent) { |
| indent.write( |
| '- (instancetype)initWithBinaryMessenger:(NSObject<FlutterBinaryMessenger> *)binaryMessenger '); |
| indent.addScoped('{', '}', () { |
| indent.writeln('self = [super init];'); |
| indent.write('if (self) '); |
| indent.addScoped('{', '}', () { |
| indent.writeln('_binaryMessenger = binaryMessenger;'); |
| }); |
| indent.writeln('return self;'); |
| }); |
| } |
| |
| void _writeMethod(ObjcOptions languageOptions, Root root, Indent indent, |
| Api api, Method func) { |
| final _ObjcPtr returnType = |
| _objcTypeForDartType(languageOptions.prefix, func.returnType); |
| final String callbackType = _callbackForType(func.returnType, returnType); |
| |
| String argNameFunc(int count, NamedType arg) => _getSafeArgName(count, arg); |
| final Iterable<String> argNames = indexMap(func.arguments, argNameFunc); |
| String sendArgument; |
| if (func.arguments.isEmpty) { |
| sendArgument = 'nil'; |
| } else { |
| String makeVarOrNSNullExpression(String x) => '$x ?: [NSNull null]'; |
| sendArgument = '@[${argNames.map(makeVarOrNSNullExpression).join(', ')}]'; |
| } |
| indent.write(_makeObjcSignature( |
| func: func, |
| options: languageOptions, |
| returnType: 'void', |
| lastArgName: 'completion', |
| lastArgType: callbackType, |
| argNameFunc: argNameFunc, |
| isEnum: (TypeDeclaration t) => isEnum(root, t), |
| )); |
| indent.addScoped(' {', '}', () { |
| indent.writeln('FlutterBasicMessageChannel *channel ='); |
| indent.nest(1, () { |
| indent.writeln('[FlutterBasicMessageChannel'); |
| indent.nest(1, () { |
| indent |
| .writeln('messageChannelWithName:@"${makeChannelName(api, func)}"'); |
| indent.writeln('binaryMessenger:self.binaryMessenger'); |
| indent.write( |
| 'codec:${_getCodecGetterName(languageOptions.prefix, api.name)}()'); |
| indent.addln('];'); |
| }); |
| }); |
| indent.write('[channel sendMessage:$sendArgument reply:^(id reply) '); |
| indent.addScoped('{', '}];', () { |
| if (func.returnType.isVoid) { |
| indent.writeln('completion(nil);'); |
| } else { |
| indent.writeln('${returnType.ptr}output = reply;'); |
| indent.writeln('completion(output, nil);'); |
| } |
| }); |
| }); |
| } |
| |
| /// Looks through the AST for features that aren't supported by the ObjC |
| /// generator. |
| List<Error> validateObjc(ObjcOptions options, Root root) { |
| final List<Error> errors = <Error>[]; |
| for (final Api api in root.apis) { |
| for (final Method method in api.methods) { |
| for (final NamedType arg in method.arguments) { |
| if (isEnum(root, arg.type) && arg.type.isNullable) { |
| // TODO(gaaclarke): Add line number. |
| errors.add(Error( |
| message: |
| "Nullable enum types aren't support in ObjC arguments in method:${api.name}.${method.name} argument:(${arg.type.baseName} ${arg.name}).")); |
| } |
| } |
| } |
| } |
| |
| return errors; |
| } |
