AndroidIdeInfoProvider exposed to Skylark (as AndroidIdeInfo).

RELNOTES: None.
PiperOrigin-RevId: 204801047

1 files changed, 296 insertions, 0 deletions

diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidIdeInfoProviderApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidIdeInfoProviderApi.java
new file mode 100644
index 0000000000..8c6424e609
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidIdeInfoProviderApi.java
@@ -0,0 +1,296 @@
+// Copyright 2017 The Bazel Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package com.google.devtools.build.lib.skylarkbuildapi.android;
+
+import com.google.common.collect.ImmutableCollection;
+import com.google.common.collect.ImmutableMap;
+import com.google.devtools.build.lib.skylarkbuildapi.FileApi;
+import com.google.devtools.build.lib.skylarkbuildapi.ProviderApi;
+import com.google.devtools.build.lib.skylarkbuildapi.StructApi;
+import com.google.devtools.build.lib.skylarkbuildapi.java.OutputJarApi;
+import com.google.devtools.build.lib.skylarkinterface.Param;
+import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
+import com.google.devtools.build.lib.skylarkinterface.SkylarkConstructor;
+import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
+import com.google.devtools.build.lib.syntax.EvalException;
+import com.google.devtools.build.lib.syntax.SkylarkDict;
+import com.google.devtools.build.lib.syntax.SkylarkList;
+import com.google.devtools.build.lib.syntax.SkylarkNestedSet;
+import javax.annotation.Nullable;
+
+/**
+ * Configured targets implementing this provider can contribute Android-specific info to IDE to the
+ * compilation.
+ */
+@SkylarkModule(name = "AndroidIdeInfo", doc = "", documented = false)
+public interface AndroidIdeInfoProviderApi<
+        FileT extends FileApi, OutputJarT extends OutputJarApi<FileT>>
+    extends StructApi {
+
+  /** Name of this info object. */
+  public static String NAME = "AndroidIdeInfo";
+
+  /** Returns the Java package. */
+  @SkylarkCallable(name = "java_package", structField = true, doc = "", documented = false)
+  String getJavaPackage();
+
+  /** Returns the direct AndroidManifest. */
+  @SkylarkCallable(
+      name = "manifest",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  FileT getManifest();
+
+  /** Returns the direct generated AndroidManifest. */
+  @SkylarkCallable(
+      name = "generated_manifest",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  FileT getGeneratedManifest();
+
+  @SkylarkCallable(
+      name = "idl_import_root",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  String getIdlImportRoot();
+
+  /** A list of sources from the "idl_srcs" attribute. */
+  @SkylarkCallable(name = "idl_srcs", structField = true, doc = "", documented = false)
+  ImmutableCollection<FileT> getIdlSrcs();
+
+  /** A list of java files generated from the "idl_srcs" attribute. */
+  @SkylarkCallable(
+      name = "idl_generated_java_files",
+      structField = true,
+      doc = "",
+      documented = false)
+  ImmutableCollection<FileT> getIdlGeneratedJavaFiles();
+
+  @SkylarkCallable(
+      name = "idl_source_jar",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  FileT getIdlSourceJar();
+
+  @SkylarkCallable(
+      name = "idl_class_jar",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  FileT getIdlClassJar();
+
+  /**
+   * Returns true if the target defined Android resources. Exposes {@link
+   * LocalResourceContainer#definesAndroidResources(AttributeMap)}
+   */
+  @SkylarkCallable(
+      name = "defines_android_resources",
+      structField = true,
+      doc = "",
+      documented = false)
+  boolean definesAndroidResources();
+
+  @SkylarkCallable(
+      name = "resource_jar",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  OutputJarT getResourceJar();
+
+  @SkylarkCallable(
+      name = "resource_apk",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  FileT getResourceApk();
+
+  /** Returns the direct debug key signed apk, if there is one. */
+  @SkylarkCallable(
+      name = "signed_apk",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  FileT getSignedApk();
+
+  @SkylarkCallable(
+      name = "aar",
+      structField = true,
+      doc = "",
+      documented = false,
+      allowReturnNones = true)
+  @Nullable
+  FileT getAar();
+
+  /** A list of the APKs related to the app under test, if any. */
+  @SkylarkCallable(name = "apks_under_test", structField = true, doc = "", documented = false)
+  ImmutableCollection<FileT> getApksUnderTest();
+
+  /** A map, keyed on architecture, of the native libs for the app, if any. */
+  @SkylarkCallable(name = "native_libs", structField = true, doc = "", documented = false)
+  ImmutableMap<String, SkylarkNestedSet> getNativeLibsSkylark();
+
+  /** The provider implementing this can construct the AndroidIdeInfo provider. */
+  @SkylarkModule(name = "Provider", doc = "", documented = false)
+  public interface Provider<FileT extends FileApi, OutputJarT extends OutputJarApi<FileT>>
+      extends ProviderApi {
+
+    @SkylarkCallable(
+        name = NAME,
+        doc = "The <code>AndroidIdeInfo</code> constructor.",
+        parameters = {
+          @Param(
+              name = "java_package",
+              doc = "A string of the Java package.",
+              positional = true,
+              named = false,
+              type = String.class),
+          @Param(
+              name = "manifest",
+              doc = "An artifact of the Android manifest.",
+              positional = true,
+              named = false,
+              noneable = true,
+              type = FileApi.class),
+          @Param(
+              name = "generated_manifest",
+              doc = "An artifact of the generated Android manifest.",
+              positional = true,
+              named = false,
+              noneable = true,
+              type = FileApi.class),
+          @Param(
+              name = "idl_import_root",
+              doc = "A string of the idl import root.",
+              positional = true,
+              named = false,
+              type = String.class),
+          @Param(
+              name = "idl_srcs",
+              doc = "A list of artifacts of the idl srcs.",
+              positional = true,
+              named = false,
+              type = SkylarkList.class,
+              generic1 = FileApi.class),
+          @Param(
+              name = "idl_generated_java_files",
+              doc = "A list of artifacts of the idl generated java files.",
+              positional = true,
+              named = false,
+              type = SkylarkList.class,
+              generic1 = FileApi.class),
+          @Param(
+              name = "idl_source_jar",
+              doc = "An artifact of the source Jar with the idl generated java files.",
+              positional = true,
+              named = false,
+              noneable = true,
+              type = FileApi.class),
+          @Param(
+              name = "idl_class_jar",
+              doc = "An artifact of the class Jar with the compiled idl generated java files.",
+              positional = true,
+              named = false,
+              noneable = true,
+              type = FileApi.class),
+          @Param(
+              name = "defines_android_resources",
+              doc = "A boolean if target specifies Android resources.",
+              positional = true,
+              named = false,
+              type = Boolean.class),
+          @Param(
+              name = "resource_jar",
+              doc = "An artifact of the Jar containing Android resources.",
+              positional = true,
+              named = false,
+              noneable = true,
+              type = OutputJarApi.class),
+          @Param(
+              name = "resource_apk",
+              doc = "An artifact of the Apk containing Android resources.",
+              positional = true,
+              named = false,
+              type = FileApi.class),
+          @Param(
+              name = "signed_apk",
+              doc = "An artifact of the signed Apk.",
+              positional = true,
+              named = false,
+              noneable = true,
+              type = FileApi.class),
+          @Param(
+              name = "aar",
+              doc = "An artifact of the Android archive.",
+              positional = true,
+              named = false,
+              noneable = true,
+              type = FileApi.class),
+          @Param(
+              name = "apks_under_test",
+              doc = "A list of artifacts of the apks under test",
+              positional = true,
+              named = false,
+              type = SkylarkList.class,
+              generic1 = FileApi.class),
+          @Param(
+              name = "native_libs",
+              doc =
+                  "A dictionary of string to a list of artifacts mapping architectures to native "
+                      + "libs.",
+              positional = true,
+              named = false,
+              type = SkylarkDict.class,
+              generic1 = String.class)
+        },
+        selfCall = true)
+    @SkylarkConstructor(objectType = AndroidIdeInfoProviderApi.class)
+    AndroidIdeInfoProviderApi<FileT, OutputJarT> createInfo(
+        String javaPackage,
+        /*noneable*/ Object manifest,
+        /*noneable*/ Object generatedManifest,
+        String idlImportRoot,
+        SkylarkList<FileT> idlSrcs,
+        SkylarkList<FileT> idlGeneratedJavaFiles,
+        /*noneable*/ Object idlSourceJar,
+        /*noneable*/ Object idlClassJar,
+        boolean definesAndroidResources,
+        /*noneable*/ Object resourceJar,
+        FileT resourceApk,
+        /*noneable*/ Object signedApk,
+        /*noneable*/ Object aar,
+        SkylarkList<FileT> apksUnderTest,
+        SkylarkDict<String, SkylarkNestedSet> nativeLibs)
+        throws EvalException;
+  }
+}