Merge pull request #39 from atorstling/include_source_info

support for including source info in descriptor set
sergei-ivanov · Dec 18, 2015 · 485cafd · 485cafd
2 parents 122dbd0 + 8131de4
commit 485cafd
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 6 deletions.
diff --git a/src/main/java/com/google/protobuf/maven/AbstractProtocMojo.java b/src/main/java/com/google/protobuf/maven/AbstractProtocMojo.java
@@ -320,6 +320,18 @@ abstract class AbstractProtocMojo extends AbstractMojo {
     )
     protected boolean includeDependenciesInDescriptorSet;
 
+    /**
+     * If {@code true} and {@code writeDescriptorSet} has been set, do not strip SourceCodeInfo 
+     * from the FileDescriptorProto. This results in vastly larger descriptors that include information 
+     * about the original location of each decl in the source file as well as surrounding comments.
+     * @since 0.4.4
+     */
+    @Parameter(
+            required = false,
+            defaultValue = "false"
+    )
+    protected boolean includeSourceInfoInDescriptorSet;
+
     /**
      * Specifies one of more custom protoc plugins, written in Java
      * and available as Maven artifacts. An executable plugin will be created
@@ -507,9 +519,9 @@ public void execute() throws MojoExecutionException, MojoFailureException {
                     }
                     if (exitStatus != 0) {
                         getLog().error("PROTOC FAILED: " + protoc.getError());
-                        for( File pf : protoFiles ) {
-                            buildContext.removeMessages( pf );
-                            buildContext.addMessage( pf, 0, 0, protoc.getError(), BuildContext.SEVERITY_ERROR, null);
+                        for (File pf : protoFiles) {
+                            buildContext.removeMessages(pf);
+                            buildContext.addMessage(pf, 0, 0, protoc.getError(), BuildContext.SEVERITY_ERROR, null);
                         }
                         throw new MojoFailureException(
                                 "protoc did not exit cleanly. Review output for more information.");
@@ -629,7 +641,10 @@ protected void addProtocBuilderParameters(final Protoc.Builder protocBuilder) th
             final File descriptorSetFile = new File(getDescriptorSetOutputDirectory(), descriptorSetFileName);
             getLog().info("Will write descriptor set:");
             getLog().info(" " + descriptorSetFile.getAbsolutePath());
-            protocBuilder.withDescriptorSetFile(descriptorSetFile, includeDependenciesInDescriptorSet);
+            protocBuilder.withDescriptorSetFile(
+                    descriptorSetFile,
+                    includeDependenciesInDescriptorSet,
+                    includeSourceInfoInDescriptorSet);
         }
     }
 

diff --git a/src/main/java/com/google/protobuf/maven/Protoc.java b/src/main/java/com/google/protobuf/maven/Protoc.java
@@ -86,6 +86,8 @@ final class Protoc {
 
     private final boolean includeImportsInDescriptorSet;
 
+    private final boolean includeSourceInfoInDescriptorSet;
+
     /**
      * A buffer to consume standard output from the {@code protoc} executable.
      */
@@ -108,8 +110,10 @@ final class Protoc {
      * @param pythonOutputDirectory a directory into which Python source files will be generated.
      * @param customOutputDirectory a directory into which a custom protoc plugin will generate files.
      * @param descriptorSetFile The directory into which a descriptor set will be generated;
-     * if {@code null}, no descriptor set will be written
+     *                          if {@code null}, no descriptor set will be written
      * @param includeImportsInDescriptorSet If {@code true}, dependencies will be included in the descriptor set.
+     * @param includeSourceInfoInDescriptorSet If {@code true}, source code information will be included 
+     *                                         in the descriptor set.
      * @param plugins a set of java protoc plugins.
      * @param pluginDirectory location of protoc plugins to be added to system path.
      * @param nativePluginId a unique id of a native plugin.
@@ -127,6 +131,7 @@ private Protoc(
             final File customOutputDirectory,
             final File descriptorSetFile,
             final boolean includeImportsInDescriptorSet,
+            final boolean includeSourceInfoInDescriptorSet,
             final ImmutableSet<ProtocPlugin> plugins,
             final File pluginDirectory,
             final String nativePluginId,
@@ -142,6 +147,7 @@ private Protoc(
         this.customOutputDirectory = customOutputDirectory;
         this.descriptorSetFile = descriptorSetFile;
         this.includeImportsInDescriptorSet = includeImportsInDescriptorSet;
+        this.includeSourceInfoInDescriptorSet = includeSourceInfoInDescriptorSet;
         this.plugins = plugins;
         this.pluginDirectory = pluginDirectory;
         this.nativePluginId = nativePluginId;
@@ -221,6 +227,9 @@ public ImmutableList<String> buildProtocCommand() {
             if (includeImportsInDescriptorSet) {
                 command.add("--include_imports");
             }
+            if (includeSourceInfoInDescriptorSet) {
+                command.add("--include_source_info");
+            }
         }
         return ImmutableList.copyOf(command);
     }
@@ -366,6 +375,8 @@ static final class Builder {
 
         private boolean includeImportsInDescriptorSet;
 
+        private boolean includeSourceInfoInDescriptorSet;
+
         /**
          * Constructs a new builder.
          *
@@ -521,11 +532,15 @@ public void setNativePluginParameter(final String nativePluginParameter) {
             this.nativePluginParameter = nativePluginParameter;
         }
 
-        public Builder withDescriptorSetFile(final File descriptorSetFile, final boolean includeImports) {
+        public Builder withDescriptorSetFile(
+                final File descriptorSetFile,
+                final boolean includeImports,
+                final boolean includeSourceInfoInDescriptorSet) {
             checkNotNull(descriptorSetFile, "descriptorSetFile");
             checkArgument(descriptorSetFile.getParentFile().isDirectory());
             this.descriptorSetFile = descriptorSetFile;
             this.includeImportsInDescriptorSet = includeImports;
+            this.includeSourceInfoInDescriptorSet = includeSourceInfoInDescriptorSet;
             return this;
         }
 
@@ -622,6 +637,7 @@ public Protoc build() {
                     customOutputDirectory,
                     descriptorSetFile,
                     includeImportsInDescriptorSet,
+                    includeSourceInfoInDescriptorSet,
                     ImmutableSet.copyOf(plugins),
                     pluginDirectory,
                     nativePluginId,