build/android/java_cpp_template.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 generate Java source files from templates that are processed
   7 # through the host C pre-processor.
   8 #
   9 # To use this, create a gyp target with the following form:
  10 #  {
  11 #    'target_name': 'android_net_java_constants',
  12 #    'type': 'none',
  13 #    'sources': [
  14 #      'net/android/NetError.template',
  15 #    ],
  16 #    'variables': {
  17 #      'package_name': 'org/chromium/net',
  18 #      'template_deps': ['net/base/certificate_mime_type_list.h'],
  19 #    },
  20 #    'includes': [ '../build/android/java_cpp_template.gypi' ],
  21 #  },
  22 #
  23 # The 'sources' entry should only list template file. The template file
  24 # itself should use the 'ClassName.template' format, and will generate
  25 # 'gen/templates/<package-name>/ClassName.java. The files which template
  26 # dependents on and typically included by the template should be listed
  27 # in template_deps variables. Any change to them will force a rebuild of
  28 # the template, and hence of any source that depends on it.
  29 #
  30
  31 {
  32   # Location where all generated Java sources will be placed.
  33   'variables': {
  34     'include_path%': '<(DEPTH)',
  35     'output_dir': '<(SHARED_INTERMEDIATE_DIR)/templates/<(package_name)',
  36   },
  37   'direct_dependent_settings': {
  38     'variables': {
  39       # Ensure that the output directory is used in the class path
  40       # when building targets that depend on this one.
  41       'generated_src_dirs': [
  42         '<(output_dir)/',
  43       ],
  44       # Ensure dependents are rebuilt when sources for this rule change.
  45       'additional_input_paths': [
  46         '<@(_sources)',
  47         '<@(template_deps)',
  48       ],
  49     },
  50   },
  51   # Define a single rule that will be apply to each .template file
  52   # listed in 'sources'.
  53   'rules': [
  54     {
  55       'rule_name': 'generate_java_constants',
  56       'extension': 'template',
  57       # Set template_deps as additional dependencies.
  58       'variables': {
  59         'output_path': '<(output_dir)/<(RULE_INPUT_ROOT).java',
  60       },
  61       'inputs': [
  62         '<(DEPTH)/build/android/gyp/util/build_utils.py',
  63         '<(DEPTH)/build/android/gyp/gcc_preprocess.py',
  64         '<@(template_deps)'
  65       ],
  66       'outputs': [
  67         '<(output_path)',
  68       ],
  69       'action': [
  70         'python', '<(DEPTH)/build/android/gyp/gcc_preprocess.py',
  71         '--include-path=<(include_path)',
  72         '--output=<(output_path)',
  73         '--template=<(RULE_INPUT_PATH)',
  74       ],
  75       'message': 'Generating Java from cpp template <(RULE_INPUT_PATH)',
  76     }
  77   ],
  78 }