Addtional list of proto_paths

Allow to provide an addtional list of directories used to resolve import directive. The list of directories is added after the proto file directory. This enables a scenario when dependencies in the proto file directory hide those somewhere else.

Author: bbyk

resources/messages/PbBundle.properties

@@ -59,6 +59,7 @@ compiler.description=protoc
 compiler.configurable.enable.compilation.text=Enable compilation
 compiler.configurable.protobuf.output.panel.label=Protobuf compiler output
 compiler.configurable.path.to.compiler.text=Path to protoc:
+compiler.configurable.additionalProtoPaths.text=Additional proto paths:
 compiler.configurable.source.directory=Output source directory:
 compiler.validate.error.title=Protocol Buffers compiler
 compiler.validate.error.unsupported.os=Plugin compiler does not support this OS.
@@ -80,3 +81,4 @@ facet.protobuf.installation.chooser.title = Path to the Google Protocol Buffers
 facet.protobuf.output.dir.chooser.title = Path to the Google Protocol Buffers output directory
 facet.protobuf.configuration.missing_output_dir = Please specify the output directory in the Protocol Buffers facet configuration for module {0}. <a href="configure">Configure</a>
 file.chooser.description.select.output.directory.for.files.generated.by.protobuf.compiler = Select the output directory for files generated by the Google Protocol Buffers compiler
+compiler.configurable.postProtoPaths.text=[compiler.configurable.additionalProtoPaths.text / messages/PbBundle]

src/protobuf/compiler/PbCompiler.java

@@ -144,6 +144,9 @@ public void run(final Result<PsiDirectory> result) {
  StringBuilder compilerCommand = new StringBuilder();
  compilerCommand.append(protocPath);
  compilerCommand.append(" --proto_path=").append(item.getBaseDir());
+ for (String addtionalProtoPath : getAdditionalProtoPaths()) {
+ compilerCommand.append(" --proto_path=").append(addtionalProtoPath);
+ }
  compilerCommand.append(" --java_out=").append(outputPath);
  compilerCommand.append(" ").append(item.getPath());
  LOG.info("Invoking protoc: " + compilerCommand.toString());
@@ -331,6 +334,10 @@ private String getPathToCompiler() {
  return compilerAppSettings.PATH_TO_COMPILER;
  }
 
+ private String[] getAdditionalProtoPaths() {
+ return compilerAppSettings.ADDITIONAL_PROTO_PATHS.split(";");
+ }
+
  private void processStreams(CompileContext context, InputStream inp, InputStream err, PbGenerationItem item) {
  try {
  String[] errorLines = StreamUtil.readText(err).trim().split("\n");

src/protobuf/settings/application/PbCompilerApplicationSettings.java

@@ -5,6 +5,9 @@
 import com.intellij.util.xmlb.XmlSerializerUtil;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Collections;
+import java.util.List;
+
 /**
  * @author Nikolay Matveev
  * Date: Apr 5, 2010
@@ -19,7 +22,8 @@
 )
 public class PbCompilerApplicationSettings implements PersistentStateComponent<PbCompilerApplicationSettings>, ApplicationComponent {
 
- public String PATH_TO_COMPILER = ""; 
+ public String PATH_TO_COMPILER = "";
+ public String ADDITIONAL_PROTO_PATHS = "";
 
  public static PbCompilerApplicationSettings getInstance() {
  return ApplicationManager.getApplication().getComponent(PbCompilerApplicationSettings.class);

src/protobuf/settings/application/PbCompilerConfigurable.form

@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <form xmlns="http://www.intellij.com/uidesigner/form/" version="1" bind-to-class="protobuf.settings.application.PbCompilerConfigurable">
- <grid id="27dc6" binding="settingsPanel" layout-manager="GridLayoutManager" row-count="2" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+ <grid id="27dc6" binding="settingsPanel" layout-manager="GridLayoutManager" row-count="2" column-count="2" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
  <margin top="0" left="0" bottom="0" right="0"/>
  <constraints>
- <xy x="20" y="20" width="500" height="400"/>
+ <xy x="20" y="20" width="618" height="400"/>
  </constraints>
  <properties/>
  <border type="none"/>
@@ -13,10 +13,10 @@
  <grid row="1" column="0" row-span="1" col-span="1" vsize-policy="6" hsize-policy="1" anchor="0" fill="2" indent="0" use-parent-layout="false"/>
  </constraints>
  </vspacer>
- <grid id="6aeae" layout-manager="GridLayoutManager" row-count="1" column-count="2" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+ <grid id="6aeae" layout-manager="GridLayoutManager" row-count="2" column-count="2" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
  <margin top="0" left="0" bottom="0" right="0"/>
  <constraints>
- <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
+ <grid row="0" column="0" row-span="1" col-span="2" vsize-policy="3" hsize-policy="3" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
  </constraints>
  <properties/>
  <border type="none"/>
@@ -31,13 +31,30 @@
  </component>
  <component id="98876" class="javax.swing.JLabel">
  <constraints>
- <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+ <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="4" fill="0" indent="0" use-parent-layout="false"/>
  </constraints>
  <properties>
  <text resource-bundle="messages/PbBundle" key="compiler.configurable.path.to.compiler.text"/>
  <toolTipText value="Path to the directory containing the protoc binary"/>
  </properties>
  </component>
+ <component id="27c76" class="javax.swing.JTextField" binding="addtionalProtoPathsField">
+ <constraints>
+ <grid row="1" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
+ <preferred-size width="150" height="-1"/>
+ </grid>
+ </constraints>
+ <properties/>
+ </component>
+ <component id="98877" class="javax.swing.JLabel">
+ <constraints>
+ <grid row="1" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="4" fill="0" indent="0" use-parent-layout="false"/>
+ </constraints>
+ <properties>
+ <text resource-bundle="messages/PbBundle" key="compiler.configurable.additionalProtoPaths.text"/>
+ <toolTipText value="Semicolon separated list of paths that will be used when resolving import directives"/>
+ </properties>
+ </component>
  </children>
  </grid>
  </children>

src/protobuf/settings/application/PbCompilerConfigurable.java

@@ -25,6 +25,7 @@
 public class PbCompilerConfigurable implements Configurable {
 
  private TextFieldWithBrowseButton pathField;
+ private JTextField addtionalProtoPathsField;
  private JPanel settingsPanel;
 
  PbCompilerApplicationSettings myAppSettings;
@@ -60,17 +61,21 @@ public JComponent createComponent() {
 
  @Override
  public boolean isModified() {
- return !myAppSettings.PATH_TO_COMPILER.equals(pathField.getText());
+ return !myAppSettings.PATH_TO_COMPILER.equals(pathField.getText())
+ || !myAppSettings.ADDITIONAL_PROTO_PATHS.equals(addtionalProtoPathsField.getText());
  }
 
  @Override
  public void apply() throws ConfigurationException {
  myAppSettings.PATH_TO_COMPILER = pathField.getText();
+ myAppSettings.ADDITIONAL_PROTO_PATHS = addtionalProtoPathsField.getText();
+
  }
 
  @Override
  public void reset() {
  pathField.setText(myAppSettings.PATH_TO_COMPILER);
+ addtionalProtoPathsField.setText(myAppSettings.ADDITIONAL_PROTO_PATHS);
  }
 
  @Override