Greatly improve (non-android) java support

build/config/android/rules.gni

 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import("//base/android/linker/config.gni")
 import("//build/config/android/config.gni")
 import("//build/config/android/internal_rules.gni")
 import("//tools/grit/grit_rule.gni")
 import("//tools/relocation_packer/config.gni")
 
@@ skipping 616 matching lines @@
   }
 
   group(target_name) {
     deps = [
       ":${target_name}__build_config",
       ":${target_name}__zip",
     ]
   }
 }
 
+# Declare a Java executable target
+#
+# This target creates an executable from java code and libraries. The executable
+# will be in the output folder's /bin/ directory.
+#
+# Variables
+#   deps: Specifies the dependencies of this target. Java targets in this list
+#     will be included in the executable (and the javac classpath).
+#
+#   java_files: List of .java files included in this library.
+#   srcjar_deps: List of srcjar dependencies. The .java files in the srcjars
+#     will be added to java_files and be included in this library.
+#   srcjars: List of srcjars to be included in this library, together with the
+#     ones obtained from srcjar_deps.
+#
+#   chromium_code: If true, extra analysis warning/errors will be enabled.
+#
+#   datadeps, testonly
+#
+# Example
+#   java_library("foo") {
+#     java_files = [ "org/chromium/foo/FooMain.java" ]
+#     deps = [ ":bar_java" ]
+#     main_class = "org.chromium.foo.FooMain"
+#   }
+template("java_binary") {

[newt (away), 2014/11/03 22:12:45]

java_library / java_binary seems to be a similar split to android_library /
android_apk... which has complicated things in the past due to lots of
duplicated functionality between the two.

Would it make sense to make java_binary simply a wrapper around java_library(s)
that specifies a main_class, but doesn't contain its own Java files?

[cjhopman, 2014/11/15 03:37:59]

I don't think we have the same problem in GN (for java_library/binary), because
all the implementation is actually shared.
I'm not totally against that but it would be inconsistent with
static_libary/executable and how java_binary seems to be done in other build
systems. (and since I don't think we will actually have the same problems as
with android_library/apk in GYP).

+  # TODO(cjhopman): This should not act like a java_library for dependents (i.e.
+  # dependents shouldn't get the jar in their classpath, etc.).
+  java_library_impl(target_name) {
+    if (defined(invoker.DEPRECATED_java_in_dir)) { DEPRECATED_java_in_dir = invoker.DEPRECATED_java_in_dir }
+    if (defined(invoker.chromium_code)) { chromium_code = invoker.chromium_code }
+    if (defined(invoker.datadeps)) { deps = invoker.datadeps }
+    if (defined(invoker.deps)) { deps = invoker.deps }
+    if (defined(invoker.java_files)) { java_files = invoker.java_files }
+    if (defined(invoker.srcjar_deps)) { srcjar_deps = invoker.srcjar_deps }
+    if (defined(invoker.srcjars)) { srcjars = invoker.srcjars }
+    if (defined(invoker.testonly)) { testonly = invoker.testonly }
+
+    main_class = invoker.main_class
+  }
+}
+
 
+# Declare an java library target
+#
+# Variables
+#   deps: Specifies the dependencies of this target. Java targets in this list
+#     will be added to the javac classpath.
+#
+#   java_files: List of .java files included in this library.
+#   srcjar_deps: List of srcjar dependencies. The .java files in the srcjars
+#     will be added to java_files and be included in this library.
+#   srcjars: List of srcjars to be included in this library, together with the
+#     ones obtained from srcjar_deps.
+#   DEPRECATED_java_in_dir: Directory containing java files. All .java files in
+#     this directory will be included in the library. This is only supported to
+#     ease the gyp->gn conversion and will be removed in the future.
+#
+#   chromium_code: If true, extra analysis warning/errors will be enabled.
+#   jar_excluded_patterns: List of patterns of .class files to exclude from the
+#     final jar.
+#
+#   proguard_preprocess: If true, proguard preprocessing will be run. This can
+#     be used to remove unwanted parts of the library.
+#   proguard_config: Path to the proguard config for preprocessing.
+#
+#   android: If true, this library will be built to support being used by

[newt (away), 2014/11/03 22:12:45]

"can_run_on_android" or "supports_android"? 

"If true, android targets (android_library, android_apk) may depend on this
target. Note: if true, this target must use only the subset of Java available on
Android."

[cjhopman, 2014/11/15 03:37:59]

Done.

+#     android-specific targets (android_library, android_apk, etc.).
+#   has_android_platform: If true, this library will support depending on

[newt (away), 2014/11/03 22:12:45]

"requires_android_platform" seems clearer to me.

s/this library will support depending on/this library may depend on

[cjhopman, 2014/11/15 03:37:59]

Done.

+#     android-specific targets. If this is the case, there should be some
+#     android-platform-like implementation available at runtime (robolectric,

[newt (away), 2014/11/03 22:12:45]

"Android, roboelectric, etc"

[cjhopman, 2014/11/15 03:37:59]

Done.

+#     for example).
+#
+#   datadeps, testonly
+#
+# Example
+#   java_library("foo_java") {
+#     java_files = [
+#       "org/chromium/foo/Foo.java",
+#       "org/chromium/foo/FooInterface.java",
+#       "org/chromium/foo/FooService.java",
+#     ]
+#     deps = [
+#       ":bar_java"
+#     ]
+#     srcjar_deps = [
+#       ":foo_generated_enum"
+#     ]
+#     jar_excluded_patterns = [
+#       "*/FooService.class", "*/FooService##*.class"
+#     ]
+#   }
+template("java_library") {
+  java_library_impl(target_name) {
+    if (defined(invoker.DEPRECATED_java_in_dir)) { DEPRECATED_java_in_dir = invoker.DEPRECATED_java_in_dir }
+    if (defined(invoker.chromium_code)) { chromium_code = invoker.chromium_code }
+    if (defined(invoker.datadeps)) { deps = invoker.datadeps }
+    if (defined(invoker.deps)) { deps = invoker.deps }
+    if (defined(invoker.jar_excluded_patterns)) { jar_excluded_patterns = invoker.jar_excluded_patterns }
+    if (defined(invoker.java_files)) { java_files = invoker.java_files }
+    if (defined(invoker.proguard_config)) { proguard_config = invoker.proguard_config }
+    if (defined(invoker.proguard_preprocess)) { proguard_preprocess = invoker.proguard_preprocess }
+    if (defined(invoker.srcjar_deps)) { srcjar_deps = invoker.srcjar_deps }
+    if (defined(invoker.srcjars)) { srcjars = invoker.srcjars }
+    if (defined(invoker.testonly)) { testonly = invoker.testonly }
+    if (defined(invoker.jar_path)) { jar_path = invoker.jar_path }
+
+    if (defined(invoker.android) && invoker.android) {
+      supports_android = true
+    }
+    if (defined(invoker.has_android_platform) && invoker.has_android_platform) {
+      supports_android = true
+      requires_android = true
+    }
+  }
+}
+
+
+# Declare an java library target for a prebuilt jar
+#
+# Variables
+#   deps: Specifies the dependencies of this target. Java targets in this list
+#     will be added to the javac classpath.
+#   jar_path: Path to the prebuilt jar.
+#   proguard_preprocess: If true, proguard preprocessing will be run. This can
+#     be used to remove unwanted parts of the library.
+#   proguard_config: Path to the proguard config for preprocessing.
+#
+# Example
+#   java_prebuilt("foo_java") {
+#     jar_path = "foo.jar"
+#     deps = [
+#       ":foo_resources",
+#       ":bar_java"
+#     ]
+#   }
+template("java_prebuilt") {
+  java_prebuilt_impl(target_name) {
+    jar_path = invoker.jar_path
+    if (defined(invoker.testonly)) { testonly = invoker.testonly }
+    if (defined(invoker.deps)) { deps = invoker.deps }
+    if (defined(invoker.proguard_config)) { proguard_config = invoker.proguard_config }
+    if (defined(invoker.proguard_preprocess)) { proguard_preprocess = invoker.proguard_preprocess }
+  }
+}
+
 # Declare an Android library target
 #
 # This target creates an Android library containing java code and Android
 # resources.
 #
 # Variables
 #   deps: Specifies the dependencies of this target. Java targets in this list
 #     will be added to the javac classpath. Android resources in dependencies
 #     will be used when building this library.
+#
 #   java_files: List of .java files included in this library.
 #   srcjar_deps: List of srcjar dependencies. The .java files in the srcjars
 #     will be added to java_files and be included in this library.
 #   srcjars: List of srcjars to be included in this library, together with the
 #     ones obtained from srcjar_deps.
+#   DEPRECATED_java_in_dir: Directory containing java files. All .java files in
+#     this directory will be included in the library. This is only supported to
+#     ease the gyp->gn conversion and will be removed in the future.
+#
 #   chromium_code: If true, extra analysis warning/errors will be enabled.
 #   jar_excluded_patterns: List of patterns of .class files to exclude from the
 #     final jar.
+#
 #   proguard_preprocess: If true, proguard preprocessing will be run. This can
 #     be used to remove unwanted parts of the library.
 #   proguard_config: Path to the proguard config for preprocessing.
 #
-#   DEPRECATED_java_in_dir: Directory containing java files. All .java files in
-#     this directory will be included in the library. This is only supported to
-#     ease the gyp->gn conversion and will be removed in the future.
 #
 # Example
 #   android_library("foo_java") {
 #     java_files = [
 #       "android/org/chromium/foo/Foo.java",
 #       "android/org/chromium/foo/FooInterface.java",
 #       "android/org/chromium/foo/FooService.java",
 #     ]
 #     deps = [
 #       ":bar_java"
 #     ]
 #     srcjar_deps = [
 #       ":foo_generated_enum"
 #     ]
 #     jar_excluded_patterns = [
 #       "*/FooService.class", "*/FooService##*.class"
 #     ]
 #   }
 template("android_library") {
-  if (defined(invoker.testonly)) { testonly = invoker.testonly }
+  assert(!defined(invoker.jar_path),
+      "android_library does not support a custom jar path")
+  java_library_impl(target_name) {
+    if (defined(invoker.DEPRECATED_java_in_dir)) { DEPRECATED_java_in_dir = invoker.DEPRECATED_java_in_dir }
+    if (defined(invoker.chromium_code)) { chromium_code = invoker.chromium_code }
+    if (defined(invoker.datadeps)) { deps = invoker.datadeps }
+    if (defined(invoker.deps)) { deps = invoker.deps }
+    if (defined(invoker.jar_excluded_patterns)) { jar_excluded_patterns = invoker.jar_excluded_patterns }
+    if (defined(invoker.java_files)) { java_files = invoker.java_files }
+    if (defined(invoker.proguard_config)) { proguard_config = invoker.proguard_config }
+    if (defined(invoker.proguard_preprocess)) { proguard_preprocess = invoker.proguard_preprocess }
+    if (defined(invoker.srcjar_deps)) { srcjar_deps = invoker.srcjar_deps }
+    if (defined(invoker.srcjars)) { srcjars = invoker.srcjars }
+    if (defined(invoker.testonly)) { testonly = invoker.testonly }
 
-  assert(defined(invoker.java_files) || defined(invoker.DEPRECATED_java_in_dir)
-      || defined(invoker.srcjars) || defined(invoker.srcjar_deps))
-  _base_path = "$target_gen_dir/$target_name"
-  _build_config = _base_path + ".build_config"
-  _jar_path = _base_path + ".jar"
-  _dex_path = _base_path + ".dex.jar"
+    supports_android = true
+    requires_android = true
 
-  write_build_config("${target_name}__build_config") {
-    type = "android_library"
-
-    deps = []
-    if (defined(invoker.deps)) {
-      deps += invoker.deps
-    }
-
-    build_config = _build_config
-    jar_path = _jar_path
-    dex_path = _dex_path
-  }
-
-  _chromium_code = true
-  if (defined(invoker.chromium_code)) {
-    _chromium_code = invoker.chromium_code
-  }
-
-  android_java_library(target_name) {
-    chromium_code = _chromium_code
-    if (defined(invoker.java_files)) {
-      java_files = invoker.java_files
-    } else if (defined(invoker.DEPRECATED_java_in_dir)) {
-      DEPRECATED_java_in_dir = invoker.DEPRECATED_java_in_dir
-    }
-    build_config = _build_config
-    jar_path = _jar_path
-    dex_path = _dex_path
-
-    if (defined(invoker.proguard_preprocess) && invoker.proguard_preprocess) {
-      proguard_preprocess = true
-      proguard_config = invoker.proguard_config
-    }
-
-    jar_excluded_patterns = [
+    if (!defined(jar_excluded_patterns)) { jar_excluded_patterns = [] }
+    jar_excluded_patterns += [
       "*/R.class", "*/R##*.class",
       "*/Manifest.class", "*/Manifest##*.class",
     ]
-    if (defined(invoker.jar_excluded_patterns)) {
-      jar_excluded_patterns += invoker.jar_excluded_patterns
-    }
-
-    if (defined(invoker.srcjar_deps)) {
-      srcjar_deps = invoker.srcjar_deps
-    }
-    if (defined(invoker.srcjars)) {
-      srcjars = invoker.srcjars
-    }
   }
 }
 
-template("java_library") {
-  if (defined(invoker.testonly)) { testonly = invoker.testonly }
-
-  assert(defined(invoker.java_files) || defined(invoker.DEPRECATED_java_in_dir)
-      || defined(invoker.srcjars))
-
-  _srcjar_deps = []
-  if (defined(invoker.srcjar_deps)) {
-    _srcjar_deps = invoker.srcjar_deps
-  }
-
-  _srcjars = []
-  if (defined(invoker.srcjars)) {
-    _srcjars = invoker.srcjars
-  }
-
-  _java_files = []
-  if (defined(invoker.java_files)) {
-    _java_files = invoker.java_files
-  } else if (defined(invoker.DEPRECATED_java_in_dir)) {
-    _src_dir = invoker.DEPRECATED_java_in_dir + "/src"
-    _src_dir_exists = exec_script("//build/dir_exists.py",
-          [ rebase_path(_src_dir, root_build_dir) ],
-          "string")
-    assert(_src_dir_exists == "False",
-        "In GN, java_in_dir should be the fully specified java directory " +
-        "(i.e. including the trailing \"/src\")")
-
-    _java_files_build_rel = exec_script(
-        "//build/android/gyp/find.py",
-        [
-          "--pattern",
-          "*.java",
-          rebase_path(invoker.DEPRECATED_java_in_dir, root_build_dir)
-        ],
-        "list lines"
-        )
-    _java_files = rebase_path(_java_files_build_rel, ".", root_build_dir)
-  }
-  assert(_java_files != [] || _srcjar_deps != [] || _srcjars != [])
-
-  # TODO(cjhopman): Write a proper build config so that java library
-  # dependencies work correctly.
-  _build_config = "$target_gen_dir/$target_name.build_config"
-  write_file(
-      _build_config,
-      "{ \"javac\": { \"classpath\": [], \"srcjars\": [] } }")
-
-  _jar_path = "$root_build_dir/lib.java/$target_name.jar"
-  if (defined(invoker.jar_path)) {
-    _jar_path = invoker.jar_path
-  }
-
-  compile_java(target_name) {
-    build_config = _build_config
-    jar_path = _jar_path
-    java_files = _java_files
-    srcjar_deps = _srcjar_deps
-    srcjars = _srcjars
-  }
-}
-
-
 # Declare an Android library target for a prebuilt jar
 #
 # This target creates an Android library containing java code and Android
 # resources.
 #
 # Variables
 #   deps: Specifies the dependencies of this target. Java targets in this list
 #     will be added to the javac classpath. Android resources in dependencies
 #     will be used when building this library.
 #   jar_path: Path to the prebuilt jar.
 #   proguard_preprocess: If true, proguard preprocessing will be run. This can
 #     be used to remove unwanted parts of the library.
 #   proguard_config: Path to the proguard config for preprocessing.
 #
 # Example
 #   android_java_prebuilt("foo_java") {
 #     jar_path = "foo.jar"
 #     deps = [
 #       ":foo_resources",
 #       ":bar_java"
 #     ]
 #   }
 template("android_java_prebuilt") {
-  if (defined(invoker.testonly)) { testonly = invoker.testonly }
-
-  assert(defined(invoker.jar_path))
-  _base_path = "${target_gen_dir}/$target_name"
-  _jar_path = _base_path + ".jar"
-  _dex_path = _base_path + ".dex.jar"
-  _build_config = _base_path + ".build_config"
-
-  write_build_config("${target_name}__build_config") {
-    type = "android_library"
-
-    deps = []
-    if (defined(invoker.deps)) {
-      deps += invoker.deps
-    }
-    build_config = _build_config
-    jar_path = _jar_path
-    dex_path = _dex_path
-  }
-
-  java_prebuilt("${target_name}__process_jar") {
-    if (defined(invoker.proguard_preprocess) && invoker.proguard_preprocess) {
-      proguard_preprocess = true
-      proguard_config = invoker.proguard_config
-    }
-
-    build_config = _build_config
-    input_jar_path = invoker.jar_path
-    output_jar_path = _jar_path
-  }
-
-  dex("${target_name}__dex") {
-    sources = [_jar_path]
-    output = _dex_path
-  }
-
-  group(target_name) {
-    deps = [
-      ":${target_name}__build_config",
-      ":${target_name}__dex",
-    ]
+  java_prebuilt_impl(target_name) {
+    jar_path = invoker.jar_path
+    supports_android = true
+    requires_android = true
+    if (defined(invoker.testonly)) { testonly = invoker.testonly }
+    if (defined(invoker.deps)) { deps = invoker.deps }
+    if (defined(invoker.proguard_config)) { proguard_config = invoker.proguard_config }
+    if (defined(invoker.proguard_preprocess)) { proguard_preprocess = invoker.proguard_preprocess }
   }
 }
 
 
 
 # Declare an Android apk target
 #
 # This target creates an Android APK containing java code, resources, assets,
 # and (possibly) native libraries.
 #
@@ skipping 39 matching lines @@
 #     native_libs = [
 #       native_lib_path
 #     ]
 #   }
 template("android_apk") {
   if (defined(invoker.testonly)) { testonly = invoker.testonly }
 
   assert(defined(invoker.final_apk_path) || defined(invoker.apk_name))
   gen_dir = "$target_gen_dir/$target_name"
   base_path = "$gen_dir/$target_name"
-  build_config = "$base_path.build_config"
+  _build_config = "$base_path.build_config"
   resources_zip_path = "$base_path.resources.zip"
   all_resources_zip_path = "$base_path.resources.all.zip"
   jar_path = "$base_path.jar"
   final_dex_path = "$gen_dir/classes.dex"
   _template_name = target_name
   _final_apk_path = ""
   if (defined(invoker.final_apk_path)) {
     _final_apk_path = invoker.final_apk_path
   } else if (defined(invoker.apk_name)) {
     _final_apk_path = "$root_build_dir/apks/" + invoker.apk_name + ".apk"
@@ skipping 54 matching lines @@
       ]
     }
 
     _enable_relocation_packing = false
     if (_use_chromium_linker && defined(invoker.enable_relocation_packing) &&
         invoker.enable_relocation_packing) {
       _enable_relocation_packing = true
     }
   }
 
-  _rebased_build_config = rebase_path(build_config, root_build_dir)
+  _rebased_build_config = rebase_path(_build_config, root_build_dir)
 
   write_build_config("${_template_name}__build_config") {
     type = "android_apk"
     dex_path = final_dex_path
     resources_zip = resources_zip_path
+    build_config = _build_config
 
     if (defined(invoker.deps)) {
       deps = invoker.deps
     }
 
     native_libs = _native_libs
   }
 
   final_deps = []
 
   final_deps += [":${_template_name}__process_resources"]
   process_resources("${_template_name}__process_resources") {
     srcjar_path = "${target_gen_dir}/${target_name}.srcjar"
     android_manifest = invoker.android_manifest
     resource_dirs = ["//build/android/ant/empty/res"]
     zip_path = resources_zip_path
     generate_constant_ids = true
+    build_config = _build_config
   }
   _srcjar_deps += [":${_template_name}__process_resources"]
 
   if (_native_libs != []) {
     _enable_chromium_linker_tests = false
     if (defined(invoker.enable_chromium_linker_tests)) {
       _enable_chromium_linker_tests = invoker.enable_chromium_linker_tests
     }
 
     _native_lib_version_name = ""
 
     java_cpp_template("${_template_name}__native_libraries_java") {
       package_name = "org/chromium/base/library_loader"
       sources = [
         "//base/android/java/templates/NativeLibraries.template",
       ]
       inputs = [
-        build_config,
+        _build_config,
       ]
 
       defines = [
         "NATIVE_LIBRARIES_LIST=" +
           "@FileArg($_rebased_build_config:native:java_libraries_list)",
         "NATIVE_LIBRARIES_VERSION_NUMBER=\"$_native_lib_version_name\"",
       ]
       if (_use_chromium_linker) {
         defines += ["ENABLE_CHROMIUM_LINKER"]
       }
       if (_load_library_from_apk) {
         defines += ["ENABLE_CHROMIUM_LINKER_LIBRARY_IN_ZIP_FILE"]
       }
       if (_enable_chromium_linker_tests) {
         defines += ["ENABLE_CHROMIUM_LINKER_TESTS"]
       }
     }
     _srcjar_deps += [ ":${_template_name}__native_libraries_java" ]
   }
 
   final_deps += [ ":${_template_name}__java" ]
-  android_java_library("${_template_name}__java") {
+  java_library_impl("${_template_name}__java") {
+    supports_android = true
+    requires_android = true
+    override_build_config = _build_config
     android_manifest = invoker.android_manifest
+    chromium_code = true
     if (defined(invoker.java_files)) {
       java_files = invoker.java_files
     } else if (defined(invoker.DEPRECATED_java_in_dir)) {
       DEPRECATED_java_in_dir = invoker.DEPRECATED_java_in_dir
     } else {
       java_files = []
     }
     srcjar_deps = _srcjar_deps
     dex_path = base_path + ".dex.jar"
   }
 
   if (_dist_jar_path != "") {
     # TODO(cjhopman): This is only ever needed to calculate the list of tests to
     # run. See build/android/pylib/instrumentation/test_jar.py. We should be
     # able to just do that calculation at build time instead.
     action("${_template_name}__create_dist_jar") {
       script = "//build/android/gyp/create_dist_jar.py"
       depfile = "$target_gen_dir/$target_name.d"
-      inputs = [ build_config ]
+      inputs = [ _build_config ]
       outputs = [
         depfile,
         _dist_jar_path,
       ]
       args = [
         "--depfile", rebase_path(depfile, root_build_dir),
         "--output", rebase_path(_dist_jar_path, root_build_dir),
         "--inputs=@FileArg($_rebased_build_config:dist_jar:dependency_jars)",
       ]
       inputs += [ jar_path ]
       _rebased_jar_path = rebase_path([ jar_path ], root_build_dir)
       args += [
         "--inputs=$_rebased_jar_path",
       ]
     }
   }
 
   final_deps += [":${_template_name}__final_dex"]
   dex("${_template_name}__final_dex") {
     deps = [ ":${_template_name}__java" ]
     sources = [ jar_path ]
-    inputs = [ build_config ]
+    inputs = [ _build_config ]
     output = final_dex_path
     dex_arg_key = "${_rebased_build_config}:apk_dex:dependency_dex_files"
     args = [ "--inputs=@FileArg($dex_arg_key)" ]
   }
 
   if (_native_libs != []) {
     action("${_template_name}__prepare_native") {
       script = "//build/android/gyp/pack_arm_relocations.py"
       packed_libraries_dir = "$_native_libs_dir/$android_app_abi"
       depfile = "$target_gen_dir/$target_name.d"
       outputs = [
         depfile
       ]
       inputs = [
-        build_config
+        _build_config
       ]
       deps = []
       skip_packing_list = [
         "gdbserver",
         "libchromium_android_linker.so",
       ]
 
       enable_packing_arg = 0
       if (_enable_relocation_packing) {
         enable_packing_arg = 1
@@ skipping 325 matching lines @@
 }
 
 # TODO(GYP): implement this.
 template("uiautomator_test") {
   if (defined(invoker.testonly)) { testonly = invoker.testonly }
   assert(target_name != "")
   assert(invoker.deps != [] || true)
   group(target_name) {
   }
 }