build/json_schema_api.gni

   1 # Copyright 2014 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 # Defines a static library corresponding to the output of schema compiler tools
   6 # over a set of extensions API schemas (IDL or JSON format.) The library target
   7 # has implicit hard dependencies on all schema files listed by the invoker and
   8 # is itself a hard dependency.
   9 #
  10 # Invocations of this template may use the following variables:
  11 #
  12 # sources [required] A list of schema files to be compiled.
  13 #
  14 # root_namespace [required]
  15 #     A Python string substituion pattern used to generate the C++
  16 #     namespace for each API. Use %(namespace)s to replace with the API
  17 #     namespace, like "toplevel::%(namespace)s_api".
  18 #
  19 # schema_include_rules [optional]
  20 #     A list of paths to include when searching for referenced objects,
  21 #     with the namespace separated by a :.
  22 #     Example:
  23 #       [ '/foo/bar:Foo::Bar::%(namespace)s' ]
  24 #
  25 # schemas [optional, default = false]
  26 #   Boolean indicating if the schema files should be generated.
  27 #
  28 # bundle [optional, default = false]
  29 #   Boolean indicating if the schema bundle files should be generated.
  30 #
  31 # bundle_registration [optional, default = false]
  32 #   Boolean indicating if the API registration bundle files should be generated.
  33 #
  34 # impl_dir [required if bundle_registration = true, otherwise unused]
  35 #   The path containing C++ implementations of API functions. This path is
  36 #   used as the root path when looking for {schema}/{schema}_api.h headers
  37 #   when generating API registration bundles. Such headers, if found, are
  38 #   automatically included by the generated code.
  39 #
  40 # uncompiled_sources [optional, only used when bundle = true or
  41 #     bundle_registration = true]
  42 #   A list of schema files which should not be compiled, but which should still
  43 #   be processed for API bundle generation.
  44 #
  45 # deps [optional]
  46 #   If any deps are specified they will be inherited by the static library
  47 #   target.
  48 #
  49 # The static library target also inherits the visibility and output_name
  50 # of its invoker.
  51
  52 template("json_schema_api") {
  53   assert(defined(invoker.sources),
  54          "\"sources\" must be defined for the $target_name template.")
  55   assert(defined(invoker.root_namespace),
  56          "\"root_namespace\" must be defined for the $target_name template.")
  57
  58   schemas = defined(invoker.schemas) && invoker.schemas
  59   bundle = defined(invoker.bundle) && invoker.bundle
  60   bundle_registration =
  61       defined(invoker.bundle_registration) && invoker.bundle_registration
  62
  63   schema_include_rules = ""
  64   if (defined(invoker.schema_include_rules)) {
  65     schema_include_rules = invoker.schema_include_rules
  66   }
  67
  68   # Keep a copy of the target_name here since it will be trampled
  69   # in nested targets.
  70   target_visibility = [ ":$target_name" ]
  71
  72   generated_config_name = target_name + "_generated_config"
  73   config(generated_config_name) {
  74     include_dirs = [ root_gen_dir ]
  75     visibility = target_visibility
  76   }
  77
  78   sources = invoker.sources
  79   root_namespace = invoker.root_namespace
  80
  81   compiler_root = "//tools/json_schema_compiler"
  82   compiler_script = "$compiler_root/compiler.py"
  83   compiler_sources = [
  84     "$compiler_root/cc_generator.py",
  85     "$compiler_root/code.py",
  86     "$compiler_root/compiler.py",
  87     "$compiler_root/cpp_generator.py",
  88     "$compiler_root/cpp_type_generator.py",
  89     "$compiler_root/cpp_util.py",
  90     "$compiler_root/h_generator.py",
  91     "$compiler_root/idl_schema.py",
  92     "$compiler_root/model.py",
  93     "$compiler_root/util_cc_helper.py",
  94   ]
  95
  96   if (schemas) {
  97     schema_generator_name = target_name + "_schema_generator"
  98     action_foreach(schema_generator_name) {
  99       script = compiler_script
 100       inputs = compiler_sources
 101       outputs = [
 102         "$target_gen_dir/{{source_name_part}}.cc",
 103         "$target_gen_dir/{{source_name_part}}.h",
 104       ]
 105       args = [
 106         "{{source}}",
 107         "--root=" + rebase_path("//", root_build_dir),
 108         "--destdir=" + rebase_path(root_gen_dir, root_build_dir),
 109         "--namespace=$root_namespace",
 110         "--generator=cpp",
 111         "--include-rules=$schema_include_rules",
 112       ]
 113
 114       if (defined(invoker.visibility)) {
 115         # If visibility is restricted, add our own target to it.
 116         visibility = invoker.visibility + target_visibility
 117       }
 118     }
 119   }
 120
 121   if (bundle) {
 122     uncompiled_sources = []
 123     if (defined(invoker.uncompiled_sources)) {
 124       uncompiled_sources = invoker.uncompiled_sources
 125     }
 126
 127     bundle_generator_schema_name = target_name + "_bundle_generator_schema"
 128     action(bundle_generator_schema_name) {
 129       script = compiler_script
 130       inputs = compiler_sources + sources + uncompiled_sources
 131       outputs = [
 132         "$target_gen_dir/generated_schemas.cc",
 133         "$target_gen_dir/generated_schemas.h",
 134       ]
 135       args = [
 136                "--root=" + rebase_path("//", root_build_dir),
 137                "--destdir=" + rebase_path(root_gen_dir, root_build_dir),
 138                "--namespace=$root_namespace",
 139                "--generator=cpp-bundle-schema",
 140                "--include-rules=$schema_include_rules",
 141              ] + rebase_path(sources, root_build_dir) +
 142              rebase_path(uncompiled_sources, root_build_dir)
 143     }
 144   }
 145
 146   if (bundle_registration) {
 147     uncompiled_sources = []
 148     if (defined(invoker.uncompiled_sources)) {
 149       uncompiled_sources = invoker.uncompiled_sources
 150     }
 151
 152     assert(defined(invoker.impl_dir),
 153            "\"impl_dir\" must be defined for the $target_name template.")
 154     impl_dir = invoker.impl_dir
 155
 156     bundle_generator_registration_name =
 157         target_name + "_bundle_generator_registration"
 158     action(bundle_generator_registration_name) {
 159       script = compiler_script
 160       inputs = compiler_sources + sources + uncompiled_sources
 161       outputs = [
 162         "$root_gen_dir/$impl_dir/generated_api_registration.cc",
 163         "$root_gen_dir/$impl_dir/generated_api_registration.h",
 164       ]
 165       args = [
 166                "--root=" + rebase_path("//", root_build_dir),
 167                "--destdir=" + rebase_path(root_gen_dir, root_build_dir),
 168                "--namespace=$root_namespace",
 169                "--generator=cpp-bundle-registration",
 170                "--impl-dir=" + rebase_path(impl_dir, "//"),
 171                "--include-rules=$schema_include_rules",
 172              ] + rebase_path(sources, root_build_dir) +
 173              rebase_path(uncompiled_sources, root_build_dir)
 174     }
 175   }
 176
 177   source_set(target_name) {
 178     sources = []
 179     deps = []
 180     public_deps = []
 181
 182     if (schemas) {
 183       sources += get_target_outputs(":$schema_generator_name")
 184       public_deps += [ ":$schema_generator_name" ]
 185       deps += [ "//tools/json_schema_compiler:generated_api_util" ]
 186     }
 187
 188     if (bundle) {
 189       sources += get_target_outputs(":$bundle_generator_schema_name")
 190       deps += [ ":$bundle_generator_schema_name" ]
 191     }
 192
 193     if (bundle_registration) {
 194       sources += get_target_outputs(":$bundle_generator_registration_name")
 195       deps += [ ":$bundle_generator_registration_name" ]
 196     }
 197
 198     if (defined(invoker.deps)) {
 199       deps += invoker.deps
 200     }
 201     public_configs = [ ":$generated_config_name" ]
 202
 203     if (defined(invoker.visibility)) {
 204       visibility = invoker.visibility
 205     }
 206     if (defined(invoker.output_name)) {
 207       output_name = invoker.output_name
 208     }
 209   }
 210 }