build/java.gypi

   1 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4
   5 # This file is meant to be included into a target to provide a rule
   6 # to build Java in a consistent manner.
   7 #
   8 # To use this, create a gyp target with the following form:
   9 # {
  10 #   'target_name': 'my-package_java',
  11 #   'type': 'none',
  12 #   'variables': {
  13 #     'package_name': 'my-package',
  14 #     'java_in_dir': 'path/to/package/root',
  15 #   },
  16 #   'includes': ['path/to/this/gypi/file'],
  17 # }
  18 #
  19 # The generated jar-file will be:
  20 #   <(PRODUCT_DIR)/lib.java/chromium_<(package_name).jar
  21 # Required variables:
  22 #  package_name - Used to name the intermediate output directory and in the
  23 #    names of some output files.
  24 #  java_in_dir - The top-level java directory. The src should be in
  25 #    <java_in_dir>/src.
  26 # Optional/automatic variables:
  27 #  additional_input_paths - These paths will be included in the 'inputs' list to
  28 #    ensure that this target is rebuilt when one of these paths changes.
  29 #  additional_src_dirs - Additional directories with .java files to be compiled
  30 #    and included in the output of this target.
  31 #  generated_src_dirs - Same as additional_src_dirs except used for .java files
  32 #    that are generated at build time. This should be set automatically by a
  33 #    target's dependencies. The .java files in these directories are not
  34 #    included in the 'inputs' list (unlike additional_src_dirs).
  35 #  input_jars_paths - The path to jars to be included in the classpath. This
  36 #    should be filled automatically by depending on the appropriate targets.
  37 #  javac_includes - A list of specific files to include. This is by default
  38 #    empty, which leads to inclusion of all files specified. May include
  39 #    wildcard, and supports '**/' for recursive path wildcards, ie.:
  40 #    '**/MyFileRegardlessOfDirectory.java', '**/IncludedPrefix*.java'.
  41 #  has_java_resources - Set to 1 if the java target contains an
  42 #    Android-compatible resources folder named res.  If 1, R_package and
  43 #    R_package_relpath must also be set.
  44 #  R_package - The java package in which the R class (which maps resources to
  45 #    integer IDs) should be generated, e.g. org.chromium.content.
  46 #  R_package_relpath - Same as R_package, but replace each '.' with '/'.
  47 #  java_strings_grd - The name of the grd file from which to generate localized
  48 #    strings.xml files, if any.
  49
  50 {
  51   'dependencies': [
  52     '<(DEPTH)/build/build_output_dirs_android.gyp:build_output_dirs'
  53   ],
  54   # This all_dependent_settings is used for java targets only. This will add the
  55   # chromium_<(package_name) jar to the classpath of dependent java targets.
  56   'all_dependent_settings': {
  57     'variables': {
  58       'input_jars_paths': ['<(PRODUCT_DIR)/lib.java/chromium_<(package_name).jar'],
  59     },
  60   },
  61   'variables': {
  62     'input_jars_paths': [],
  63     'additional_src_dirs': [],
  64     'javac_includes': [],
  65     'additional_input_paths': ['>@(additional_R_files)'],
  66     'generated_src_dirs': ['>@(generated_R_dirs)'],
  67     'generated_R_dirs': [],
  68     'additional_R_files': [],
  69     'has_java_resources%': 0,
  70     'java_strings_grd%': '',
  71   },
  72   'conditions': [
  73     ['has_java_resources == 1', {
  74       'variables': {
  75         'res_dir': '<(java_in_dir)/res',
  76         'out_res_dir': '<(SHARED_INTERMEDIATE_DIR)/<(package_name)/res',
  77         'R_dir': '<(SHARED_INTERMEDIATE_DIR)/<(package_name)/java_R',
  78         'R_file': '<(R_dir)/<(R_package_relpath)/R.java',
  79         'R_text_file': '<(R_dir)/R.txt',
  80         'generated_src_dirs': ['<(R_dir)'],
  81         'additional_input_paths': ['<(R_file)'],
  82         # grit_grd_file is used by grit_action.gypi, included below.
  83         'grit_grd_file': '<(java_in_dir)/strings/<(java_strings_grd)',
  84       },
  85       'all_dependent_settings': {
  86         'variables': {
  87           # Dependent jars include this target's R.java file via
  88           # generated_R_dirs and additional_R_files.
  89           'generated_R_dirs': ['<(R_dir)'],
  90           'additional_R_files': ['<(R_file)'],
  91           'additional_R_text_files': ['<(R_text_file)'],
  92
  93           # Dependent APKs include this target's resources via
  94           # additional_res_dirs and additional_res_packages.
  95           'additional_res_dirs': ['<(out_res_dir)', '<(res_dir)'],
  96           'additional_res_packages': ['<(R_package)'],
  97         },
  98       },
  99       'conditions': [
 100         ['java_strings_grd != ""', {
 101           'actions': [
 102             {
 103               'action_name': 'generate_localized_strings_xml',
 104               'variables': {
 105                 'grit_out_dir': '<(out_res_dir)',
 106                 # resource_ids is unneeded since we don't generate .h headers.
 107                 'grit_resource_ids': '',
 108               },
 109               'includes': ['../build/grit_action.gypi'],
 110             },
 111           ],
 112         }],
 113       ],
 114       'actions': [
 115         # Generate R.java and crunch image resources.
 116         {
 117           'action_name': 'process_resources',
 118           'message': 'processing resources for <(package_name)',
 119           'conditions': [
 120             ['java_strings_grd != ""', {
 121               'inputs': [
 122                 # TODO(newt): replace this with .../values/strings.xml once
 123                 # the English strings.xml is generated as well? That would be
 124                 # simpler and faster and should be equivalent.
 125                 '<!@pymod_do_main(grit_info <@(grit_defines) --outputs "<(out_res_dir)" <(grit_grd_file))',
 126               ],
 127             }],
 128           ],
 129           'inputs': [
 130             '<(DEPTH)/build/android/process_resources.py',
 131             '<!@(find <(res_dir) -type f)',
 132           ],
 133           'outputs': [
 134             '<(R_file)',
 135           ],
 136           'action': [
 137             '<(DEPTH)/build/android/process_resources.py',
 138             '--android-sdk', '<(android_sdk)',
 139             '--android-sdk-tools', '<(android_sdk_tools)',
 140             '--R-package', '<(R_package)',
 141             '--R-dir', '<(R_dir)',
 142             '--res-dir', '<(res_dir)',
 143             '--crunched-res-dir', '<(out_res_dir)',
 144           ],
 145         },
 146       ],
 147     }],
 148   ],
 149   'actions': [
 150     {
 151       'action_name': 'ant_<(package_name)',
 152       'message': 'Building <(package_name) java sources.',
 153       'inputs': [
 154         'android/ant/common.xml',
 155         'android/ant/chromium-jars.xml',
 156         '>!@(find >(java_in_dir) >(additional_src_dirs) -name "*.java")',
 157         '>@(input_jars_paths)',
 158         '>@(additional_input_paths)',
 159       ],
 160       'outputs': [
 161         '<(PRODUCT_DIR)/lib.java/chromium_<(package_name).jar',
 162       ],
 163       'action': [
 164         'ant', '-quiet',
 165         '-DCONFIGURATION_NAME=<(CONFIGURATION_NAME)',
 166         '-DANDROID_SDK=<(android_sdk)',
 167         '-DANDROID_SDK_ROOT=<(android_sdk_root)',
 168         '-DANDROID_SDK_TOOLS=<(android_sdk_tools)',
 169         '-DANDROID_SDK_VERSION=<(android_sdk_version)',
 170         '-DANDROID_GDBSERVER=<(android_gdbserver)',
 171         '-DPRODUCT_DIR=<(ant_build_out)',
 172
 173         '-DADDITIONAL_SRC_DIRS=>(additional_src_dirs)',
 174         '-DGENERATED_SRC_DIRS=>(generated_src_dirs)',
 175         '-DINPUT_JARS_PATHS=>(input_jars_paths)',
 176         '-DPACKAGE_NAME=<(package_name)',
 177         '-DJAVAC_INCLUDES=>(javac_includes)',
 178
 179         '-Dbasedir=<(java_in_dir)',
 180         '-buildfile',
 181         '<(DEPTH)/build/android/ant/chromium-jars.xml'
 182       ]
 183     },
 184   ],
 185 }