Allow application of external mixins to generated dart protos.

lib/file_generator.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 part of protoc;
 
+final _dartIdentifier = new RegExp(r'^\w+$');
+
 /// Generates the Dart output files for one .proto input file.
 ///
 /// Outputs include .pb.dart, pbenum.dart, and .pbjson.dart.
 class FileGenerator extends ProtobufContainer {
-  /// Returns the the mixin to use by default in this file,
-  /// or null for no mixin by default.
-  static PbMixin _getDefaultMixin(FileDescriptorProto desc) {
-    if (!desc.hasOptions()) return null;
-    if (!desc.options.hasExtension(Dart_options.defaultMixin)) {
-      return null;
+  /// Reads the declared mixins in the file, keyed by name.
+  static Map<String, DartMixin> _getDeclaredMixins(FileDescriptorProto desc) {
+    final mixins = <String, DartMixin>{};
+    if (!desc.hasOptions() || !desc.options.hasExtension(Dart_options.mixins)) {
+      return mixins;
     }
-    var name = desc.options.getExtension(Dart_options.defaultMixin);
-    PbMixin mixin = findMixin(name);
-    if (mixin == null) {
-      throw ("unknown mixin class: ${name}");
+    for (DartMixin mixin in desc.options.getExtension(Dart_options.mixins)) {
+      if (mixins.containsKey(mixin.name)) {
+        throw ('Duplicate mixin name: "${mixin.name}"');

[skybrian, 2016/06/22 19:27:18]

style nit: parentheses aren't needed.

[skybrian, 2016/06/22 20:29:52]

When we throw we should give some indication of the location in the file where
the error is. We can't give a line number unfortunately, but we could say
something like:

somefile.proto in 'mixins' file option: duplicate mixin name: SomeMixin

Similarly for other errors.

[frederikmutzel, 2016/06/23 12:30:16]

Done.

[frederikmutzel, 2016/06/23 12:30:16]

Done.

+      }
+      if (!mixin.name.startsWith(_dartIdentifier)) {
+        throw ('Mixin name "${mixin.name}" is not a valid dart class '
+            'identifier');
+      }
+      if (mixin.hasParent() && !mixin.parent.startsWith(_dartIdentifier)) {
+        throw ('Mixin parent "${mixin.parent}" of ${mixin.name} is not a valid '
+            'dart class identifier');
+      }
+      mixins[mixin.name] = mixin;
     }

[skybrian, 2016/06/22 19:27:18]

Also check for cycles?

[frederikmutzel, 2016/06/23 12:30:16]

Done.

-    return mixin;
+    return mixins;
   }
 
   final FileDescriptorProto _fileDescriptor;
 
   // The relative path used to import the .proto file, as a URI.
   final Uri protoFileUri;
 
   final List<EnumGenerator> enumGenerators = <EnumGenerator>[];
   final List<MessageGenerator> messageGenerators = <MessageGenerator>[];
   final List<ExtensionGenerator> extensionGenerators = <ExtensionGenerator>[];
   final List<ClientApiGenerator> clientApiGenerators = <ClientApiGenerator>[];
   final List<ServiceGenerator> serviceGenerators = <ServiceGenerator>[];
 
   /// True if cross-references have been resolved.
   bool _linked = false;
 
   FileGenerator(FileDescriptorProto descriptor)
       : _fileDescriptor = descriptor,
         protoFileUri = new Uri.file(descriptor.name) {
     if (protoFileUri.isAbsolute) {
       // protoc should never generate an import with an absolute path.
       throw "FAILURE: Import with absolute path is not supported";
     }
 
-    var defaultMixin = _getDefaultMixin(_fileDescriptor);
+    var declaredMixins = _getDeclaredMixins(descriptor);
+    var defaultMixin =

[skybrian, 2016/06/22 20:29:52]

should check that we can find defaultMixin.
It will be checked later, but if we do it here, we can give the proper location
of the error. (It's on the defaultMixin file option, not on the messages.)

[frederikmutzel, 2016/06/23 12:30:16]

Done.

+        descriptor.options?.getExtension(Dart_options.defaultMixin);
 
     // Load and register all enum and message types.
     for (EnumDescriptorProto enumType in _fileDescriptor.enumType) {
       enumGenerators.add(new EnumGenerator(enumType, this));
     }
     for (DescriptorProto messageType in _fileDescriptor.messageType) {
-      messageGenerators
-          .add(new MessageGenerator(messageType, this, defaultMixin));
+      messageGenerators.add(new MessageGenerator(
+          messageType, this, declaredMixins, defaultMixin));
     }
     for (FieldDescriptorProto extension in _fileDescriptor.extension) {
       extensionGenerators.add(new ExtensionGenerator(extension, this));
     }
     for (ServiceDescriptorProto service in _fileDescriptor.service) {
       var serviceGen = new ServiceGenerator(service, this);
       serviceGenerators.add(serviceGen);
       clientApiGenerators.add(new ClientApiGenerator(serviceGen));
     }
   }
@@ skipping 348 matching lines @@
       FileGenerator target, String extension) {
     Uri resolvedImport =
         config.resolveImport(target.protoFileUri, protoFileUri, extension);
     out.print("import '$resolvedImport'");
     if (package != target.package && target.package.isNotEmpty) {
       out.print(' as ${target.packageImportPrefix}');
     }
     out.println(';');
   }
 }