clean up API for file_generator.dart

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;
 
+/// 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;
     }
     var name = desc.options.getExtension(Dart_options.defaultMixin);
     PbMixin mixin = findMixin(name);
@@ skipping 87 matching lines @@
     if (_fileDescriptor.package != '') {
       // Two .protos can be in the same proto package.
       // It isn't unique enough to use as a Dart library name.
       // But we can prepend it.
       return _fileDescriptor.package + "_" + libraryName;
     }
 
     return libraryName;
   }
 
-  CodeGeneratorResponse_File generateResponse(OutputConfiguration config) {
+  /// Generates all the Dart files for this .proto file.
+  List<CodeGeneratorResponse_File> generateFiles(OutputConfiguration config) {
+    if (!_linked) throw new StateError("not linked");
+
+    makeFile(String extension, String content) {
+      Uri protoUrl = new Uri.file(_fileDescriptor.name);
+      Uri dartUrl = config.outputPathFor(protoUrl, extension);
+      return new CodeGeneratorResponse_File()
+        ..name = dartUrl.path
+        ..content = content;
+    }
+
+    return [
+      makeFile(".pb.dart", generateMainFile(config)),
+      makeFile(".pbenum.dart", generateEnumFile(config)),
+      makeFile(".pbjson.dart", generateJsonFile(config)),
+    ];
+  }
+
+  /// Returns the contents of the .pb.dart file for this .proto file.
+  String generateMainFile(
+      [OutputConfiguration config = const DefaultOutputConfiguration()]) {
+    if (!_linked) throw new StateError("not linked");
     IndentingWriter out = new IndentingWriter();
 
-    generate(out, config);
-
-    Uri filePath = new Uri.file(_fileDescriptor.name);
-    return new CodeGeneratorResponse_File()
-      ..name = config.outputPathFor(filePath, ".pb.dart").path
-      ..content = out.toString();
-  }
-
-  /// Generates the Dart code for this .proto file.
-  void generate(IndentingWriter out,
-      [OutputConfiguration config = const DefaultOutputConfiguration()]) {
-    if (!_linked) throw new StateError("not linked");
-
-    generateHeader(out, config);
+    writeMainHeader(out, config);
 
     // Generate code.
     for (MessageGenerator m in messageGenerators) {
       m.generate(out);
     }
 
     // Generate code for extensions defined at top-level using a class
     // name derived from the file name.
     if (!extensionGenerators.isEmpty) {
       // TODO(antonm): do not generate a class.
@@ skipping 10 matching lines @@
         out.println('}');
       });
     }
 
     for (ClientApiGenerator c in clientApiGenerators) {
       c.generate(out);
     }
     for (ServiceGenerator s in serviceGenerators) {
       s.generate(out);
     }
+
+    return out.toString();
   }
 
-  /// Prints header and imports.
-  void generateHeader(IndentingWriter out,
+  /// Writes the header and imports for the .pb.dart file.
+  void writeMainHeader(IndentingWriter out,
       [OutputConfiguration config = const DefaultOutputConfiguration()]) {
     String libraryName = _generateLibraryName(protoFileUri);
     out.println('///\n'
         '//  Generated code. Do not modify.\n'
         '///\n'
         'library $libraryName;\n');
 
     // We only add the dart:async import if there are services in the
     // FileDescriptorProto.
     if (_fileDescriptor.service.isNotEmpty) {
       out.println("import 'dart:async';\n");
     }
 
     if (_needsFixnumImport) {
       out.println("import 'package:fixnum/fixnum.dart';");
     }
 
     if (_needsProtobufImport) {
-    out.println("import 'package:protobuf/protobuf.dart';");
+      out.println("import 'package:protobuf/protobuf.dart';");
       out.println();
     }
 
     var mixinImports = findMixinsToImport();
     var importNames = mixinImports.keys.toList();
     importNames.sort();
     for (var imp in importNames) {
       var symbols = mixinImports[imp];
       out.println("import '${imp}' show ${symbols.join(', ')};");
     }
@@ skipping 91 matching lines @@
       symbols.add(m.name);
     }
 
     for (var imp in imports.keys) {
       imports[imp].sort();
     }
 
     return imports;
   }
 
-  CodeGeneratorResponse_File generateEnumResponse(OutputConfiguration config) {
+  /// Returns the contents of the .pbenum.dart file for this .proto file.
+  String generateEnumFile(
+      [OutputConfiguration config = const DefaultOutputConfiguration()]) {
     if (!_linked) throw new StateError("not linked");
-
-    IndentingWriter out = new IndentingWriter();
-
-    generateEnumFile(out, config);
-
-    Uri filePath = new Uri.file(_fileDescriptor.name);
-    return new CodeGeneratorResponse_File()
-      ..name = config.outputPathFor(filePath, ".pbenum.dart").path
-      ..content = out.toString();
-  }
-
-  void generateEnumFile(IndentingWriter out,
-      [OutputConfiguration config = const DefaultOutputConfiguration()]) {
     Uri filePath = new Uri.file(_fileDescriptor.name);
     if (filePath.isAbsolute) {
       // protoc should never generate a file descriptor with an absolute path.
       throw "FAILURE: File with an absolute path is not supported";
     }
 
     var baseLibraryName = _generateLibraryName(filePath);
     var libraryName = baseLibraryName + "_pbenum";
+    var out = new IndentingWriter();
     out.print('''
 ///
 //  Generated code. Do not modify.
 ///
 library $libraryName;
 
 ''');
 
     if (enumCount > 0) {
       out.println("import 'package:protobuf/protobuf.dart';");
       out.println();
     }
 
     for (EnumGenerator e in enumGenerators) {
       e.generate(out);
     }
 
     for (MessageGenerator m in messageGenerators) {
       m.generateEnums(out);
     }
+
+    return out.toString();
   }
 
   /// Returns the number of enum types generated in the .pbenum.dart file.
   int get enumCount {
     var count = enumGenerators.length;
     for (MessageGenerator m in messageGenerators) {
       count += m.enumCount;
     }
     return count;
   }
 
-  CodeGeneratorResponse_File generateJsonDartResponse(
-      OutputConfiguration config) {
+  /// Returns the contents of the .pbjson.dart file for this .proto file.
+  String generateJsonFile(
+      [OutputConfiguration config = const DefaultOutputConfiguration()]) {
     if (!_linked) throw new StateError("not linked");
-
-    IndentingWriter out = new IndentingWriter();
-
-    generateJsonDart(out, config);
-
-    Uri filePath = new Uri.file(_fileDescriptor.name);
-    return new CodeGeneratorResponse_File()
-      ..name = config.outputPathFor(filePath, ".pbjson.dart").path
-      ..content = out.toString();
-  }
-
-  void generateJsonDart(IndentingWriter out,
-      [OutputConfiguration config = const DefaultOutputConfiguration()]) {
     Uri filePath = new Uri.file(_fileDescriptor.name);
     if (filePath.isAbsolute) {
       // protoc should never generate a file descriptor with an absolute path.
       throw "FAILURE: File with an absolute path is not supported";
     }
 
     var baseLibraryName = _generateLibraryName(filePath);
     var libraryName = baseLibraryName + "_pbjson";
+    var out = new IndentingWriter();
     out.print('''
 ///
 //  Generated code. Do not modify.
 ///
 library $libraryName;
 
 ''');
 
     // Import the .pbjson.dart files we depend on.
     var importList = _findJsonProtosToImport();
@@ skipping 10 matching lines @@
 
     for (var e in enumGenerators) {
       e.generateConstants(out);
     }
     for (MessageGenerator m in messageGenerators) {
       m.generateConstants(out);
     }
     for (ServiceGenerator s in serviceGenerators) {
       s.generateConstants(out);
     }
+
+    return out.toString();
   }
 
   /// Returns the generator for each .pbjson.dart file the generated
   /// .pbjson.dart needs to import.
   Set<FileGenerator> _findJsonProtosToImport() {
     var imports = new Set<FileGenerator>.identity();
     for (var m in messageGenerators) {
       m.addConstantImportsTo(imports);
     }
     for (var x in extensionGenerators) {
       x.addConstantImportsTo(imports);
     }
     for (var x in serviceGenerators) {
       x.addConstantImportsTo(imports);
     }
     imports.remove(this); // Don't need to import self.
     return imports;
   }
 }