Alexei Frolov | e19ebb8 | 2020-05-14 17:21:20 -0700 | [diff] [blame] | 1 | # Copyright 2020 The Pigweed Authors |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | # use this file except in compliance with the License. You may obtain a copy of |
| 5 | # the License at |
| 6 | # |
| 7 | # https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | # License for the specific language governing permissions and limitations under |
| 13 | # the License. |
| 14 | |
Armando Montanez | fb3d3fb | 2020-06-09 18:12:12 -0700 | [diff] [blame] | 15 | import("//build_overrides/pigweed.gni") |
| 16 | |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 17 | import("$dir_pw_build/error.gni") |
Alexei Frolov | 05d8ef2 | 2020-06-08 10:32:29 -0700 | [diff] [blame] | 18 | import("$dir_pw_build/input_group.gni") |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 19 | import("$dir_pw_build/mirror_tree.gni") |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 20 | import("$dir_pw_build/python.gni") |
Wyatt Hepler | 51ded74 | 2020-10-19 14:45:27 -0700 | [diff] [blame] | 21 | import("$dir_pw_build/python_action.gni") |
Alexei Frolov | edd2f14 | 2020-06-09 19:11:27 -0700 | [diff] [blame] | 22 | import("$dir_pw_build/target_types.gni") |
Alexei Frolov | dd6fa5c | 2020-08-11 10:04:01 -0700 | [diff] [blame] | 23 | import("$dir_pw_third_party/nanopb/nanopb.gni") |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 24 | import("toolchain.gni") |
Wyatt Hepler | d49f8fe | 2020-10-15 10:13:47 -0700 | [diff] [blame] | 25 | |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 26 | # Variables forwarded from the public pw_proto_library template to the final |
| 27 | # pw_source_set. |
Wyatt Hepler | e0c4fdc | 2020-05-29 17:26:19 -0700 | [diff] [blame] | 28 | _forwarded_vars = [ |
| 29 | "testonly", |
| 30 | "visibility", |
| 31 | ] |
| 32 | |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 33 | # Internal template that invokes protoc with a pw_python_action. This should not |
| 34 | # be used outside of this file; use pw_proto_library instead. |
| 35 | # |
| 36 | # This creates the internal GN target $target_name.$language._gen that compiles |
| 37 | # proto files with protoc. |
| 38 | template("_pw_invoke_protoc") { |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 39 | if (current_toolchain == pw_protobuf_compiler_TOOLCHAIN) { |
Wyatt Hepler | a037764 | 2021-03-09 08:37:10 -0800 | [diff] [blame] | 40 | if (defined(invoker.out_dir)) { |
| 41 | _out_dir = invoker.out_dir |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 42 | } else { |
Wyatt Hepler | a037764 | 2021-03-09 08:37:10 -0800 | [diff] [blame] | 43 | _out_dir = "${invoker.base_out_dir}/${invoker.language}" |
| 44 | if (defined(invoker.module_as_package) && |
| 45 | invoker.module_as_package != "") { |
| 46 | assert(invoker.language == "python") |
| 47 | _out_dir = "$_out_dir/${invoker.module_as_package}" |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 48 | } |
| 49 | } |
Wyatt Hepler | a037764 | 2021-03-09 08:37:10 -0800 | [diff] [blame] | 50 | |
| 51 | _includes = |
| 52 | rebase_path(get_target_outputs(":${invoker.base_target}._includes")) |
| 53 | |
| 54 | pw_python_action("$target_name._gen") { |
| 55 | script = |
| 56 | "$dir_pw_protobuf_compiler/py/pw_protobuf_compiler/generate_protos.py" |
| 57 | |
| 58 | python_deps = [ "$dir_pw_protobuf_compiler/py" ] |
| 59 | if (defined(invoker.python_deps)) { |
| 60 | python_deps += invoker.python_deps |
| 61 | } |
| 62 | |
| 63 | deps = [ |
| 64 | ":${invoker.base_target}._includes", |
| 65 | ":${invoker.base_target}._sources", |
| 66 | ] |
| 67 | |
| 68 | foreach(dep, invoker.deps) { |
| 69 | deps += [ get_label_info(dep, "label_no_toolchain") + "._gen" ] |
| 70 | } |
| 71 | |
Wyatt Hepler | a3ca62a | 2021-05-04 16:21:43 -0700 | [diff] [blame^] | 72 | if (defined(invoker.other_deps)) { |
| 73 | deps += invoker.other_deps |
| 74 | } |
| 75 | |
Wyatt Hepler | a037764 | 2021-03-09 08:37:10 -0800 | [diff] [blame] | 76 | args = [ |
| 77 | "--language", |
| 78 | invoker.language, |
| 79 | "--include-file", |
| 80 | _includes[0], |
| 81 | "--compile-dir", |
| 82 | rebase_path(invoker.compile_dir), |
| 83 | "--out-dir", |
| 84 | rebase_path(_out_dir), |
| 85 | "--sources", |
| 86 | ] + rebase_path(invoker.sources) |
| 87 | |
| 88 | if (defined(invoker.plugin)) { |
| 89 | inputs = [ invoker.plugin ] |
| 90 | args += [ "--plugin-path=" + rebase_path(invoker.plugin) ] |
| 91 | } |
| 92 | |
| 93 | if (defined(invoker.outputs)) { |
| 94 | outputs = invoker.outputs |
| 95 | } else { |
| 96 | stamp = true |
| 97 | } |
| 98 | |
| 99 | if (defined(invoker.metadata)) { |
| 100 | metadata = invoker.metadata |
| 101 | } else { |
| 102 | metadata = { |
| 103 | protoc_outputs = rebase_path(outputs) |
| 104 | root = [ rebase_path(_out_dir) ] |
| 105 | } |
| 106 | } |
| 107 | } |
| 108 | } else { |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 109 | # protoc is only ever invoked from pw_protobuf_compiler_TOOLCHAIN. |
Wyatt Hepler | a037764 | 2021-03-09 08:37:10 -0800 | [diff] [blame] | 110 | not_needed([ "target_name" ]) |
| 111 | not_needed(invoker, "*") |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 112 | } |
| 113 | } |
| 114 | |
Alexei Frolov | f39cd8b | 2020-04-13 17:59:20 -0700 | [diff] [blame] | 115 | # Generates pw_protobuf C++ code for proto files, creating a source_set of the |
| 116 | # generated files. This is internal and should not be used outside of this file. |
| 117 | # Use pw_proto_library instead. |
Alexei Frolov | f39cd8b | 2020-04-13 17:59:20 -0700 | [diff] [blame] | 118 | template("_pw_pwpb_proto_library") { |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 119 | _pw_invoke_protoc(target_name) { |
| 120 | forward_variables_from(invoker, "*", _forwarded_vars) |
| 121 | language = "pwpb" |
| 122 | plugin = "$dir_pw_protobuf/py/pw_protobuf/plugin.py" |
Wyatt Hepler | 438caa0 | 2021-01-15 17:13:11 -0800 | [diff] [blame] | 123 | python_deps = [ "$dir_pw_protobuf/py" ] |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | # Create a library with the generated source files. |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 127 | config("$target_name._include_path") { |
| 128 | include_dirs = [ "${invoker.base_out_dir}/pwpb" ] |
| 129 | visibility = [ ":*" ] |
| 130 | } |
| 131 | |
Alexei Frolov | edd2f14 | 2020-06-09 19:11:27 -0700 | [diff] [blame] | 132 | pw_source_set(target_name) { |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 133 | forward_variables_from(invoker, _forwarded_vars) |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 134 | public_configs = [ ":$target_name._include_path" ] |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 135 | deps = [ ":$target_name._gen($pw_protobuf_compiler_TOOLCHAIN)" ] |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 136 | public_deps = [ dir_pw_protobuf ] + invoker.deps |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 137 | sources = invoker.outputs |
Alexei Frolov | f39cd8b | 2020-04-13 17:59:20 -0700 | [diff] [blame] | 138 | public = filter_include(sources, [ "*.pwpb.h" ]) |
| 139 | } |
| 140 | } |
| 141 | |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 142 | # Generates nanopb RPC code for proto files, creating a source_set of the |
| 143 | # generated files. This is internal and should not be used outside of this file. |
| 144 | # Use pw_proto_library instead. |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 145 | template("_pw_nanopb_rpc_proto_library") { |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 146 | # Create a target which runs protoc configured with the nanopb_rpc plugin to |
| 147 | # generate the C++ proto RPC headers. |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 148 | _pw_invoke_protoc(target_name) { |
| 149 | forward_variables_from(invoker, "*", _forwarded_vars) |
| 150 | language = "nanopb_rpc" |
| 151 | plugin = "$dir_pw_rpc/py/pw_rpc/plugin_nanopb.py" |
Wyatt Hepler | 438caa0 | 2021-01-15 17:13:11 -0800 | [diff] [blame] | 152 | python_deps = [ "$dir_pw_rpc/py" ] |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | # Create a library with the generated source files. |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 156 | config("$target_name._include_path") { |
| 157 | include_dirs = [ "${invoker.base_out_dir}/nanopb_rpc" ] |
| 158 | visibility = [ ":*" ] |
| 159 | } |
| 160 | |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 161 | pw_source_set(target_name) { |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 162 | forward_variables_from(invoker, _forwarded_vars) |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 163 | public_configs = [ ":$target_name._include_path" ] |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 164 | deps = [ ":$target_name._gen($pw_protobuf_compiler_TOOLCHAIN)" ] |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 165 | public_deps = [ |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 166 | ":${invoker.base_target}.nanopb", |
Wyatt Hepler | cbd09c2 | 2020-09-15 11:17:24 -0700 | [diff] [blame] | 167 | "$dir_pw_rpc:server", |
Alexei Frolov | a4d7150 | 2020-10-14 12:43:14 -0700 | [diff] [blame] | 168 | "$dir_pw_rpc/nanopb:method_union", |
Alexei Frolov | dd6fa5c | 2020-08-11 10:04:01 -0700 | [diff] [blame] | 169 | "$dir_pw_third_party/nanopb", |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 170 | ] + invoker.deps |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 171 | public = invoker.outputs |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 172 | } |
| 173 | } |
| 174 | |
Alexei Frolov | f39cd8b | 2020-04-13 17:59:20 -0700 | [diff] [blame] | 175 | # Generates nanopb code for proto files, creating a source_set of the generated |
| 176 | # files. This is internal and should not be used outside of this file. Use |
| 177 | # pw_proto_library instead. |
Alexei Frolov | f39cd8b | 2020-04-13 17:59:20 -0700 | [diff] [blame] | 178 | template("_pw_nanopb_proto_library") { |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 179 | # When compiling with the Nanopb plugin, the nanopb.proto file is already |
| 180 | # compiled internally, so skip recompiling it with protoc. |
| 181 | if (rebase_path(invoker.sources, invoker.compile_dir) == [ "nanopb.proto" ]) { |
| 182 | group("$target_name._gen") { |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 183 | deps = [ |
| 184 | ":${invoker.base_target}._sources($pw_protobuf_compiler_TOOLCHAIN)", |
| 185 | ] |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 186 | } |
Alexei Frolov | f39cd8b | 2020-04-13 17:59:20 -0700 | [diff] [blame] | 187 | |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 188 | group("$target_name") { |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 189 | deps = invoker.deps + |
| 190 | [ ":$target_name._gen($pw_protobuf_compiler_TOOLCHAIN)" ] |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 191 | } |
| 192 | } else { |
| 193 | # Create a target which runs protoc configured with the nanopb plugin to |
| 194 | # generate the C proto sources. |
| 195 | _pw_invoke_protoc(target_name) { |
| 196 | forward_variables_from(invoker, "*", _forwarded_vars) |
| 197 | language = "nanopb" |
| 198 | plugin = "$dir_pw_third_party_nanopb/generator/protoc-gen-nanopb" |
Wyatt Hepler | a3ca62a | 2021-05-04 16:21:43 -0700 | [diff] [blame^] | 199 | other_deps = [ "$dir_pw_third_party/nanopb:generate_nanopb_proto.action" ] |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 200 | } |
| 201 | |
| 202 | # Create a library with the generated source files. |
| 203 | config("$target_name._include_path") { |
| 204 | include_dirs = [ "${invoker.base_out_dir}/nanopb" ] |
| 205 | visibility = [ ":*" ] |
| 206 | } |
| 207 | |
| 208 | pw_source_set(target_name) { |
| 209 | forward_variables_from(invoker, _forwarded_vars) |
| 210 | public_configs = [ ":$target_name._include_path" ] |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 211 | deps = [ ":$target_name._gen($pw_protobuf_compiler_TOOLCHAIN)" ] |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 212 | public_deps = [ "$dir_pw_third_party/nanopb" ] + invoker.deps |
| 213 | sources = invoker.outputs |
| 214 | public = filter_include(sources, [ "*.pb.h" ]) |
| 215 | } |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 216 | } |
| 217 | } |
| 218 | |
Alexei Frolov | c912ea7 | 2020-10-26 08:43:27 -0700 | [diff] [blame] | 219 | # Generates raw RPC code for proto files, creating a source_set of the generated |
| 220 | # files. This is internal and should not be used outside of this file. Use |
| 221 | # pw_proto_library instead. |
Alexei Frolov | c912ea7 | 2020-10-26 08:43:27 -0700 | [diff] [blame] | 222 | template("_pw_raw_rpc_proto_library") { |
Alexei Frolov | c912ea7 | 2020-10-26 08:43:27 -0700 | [diff] [blame] | 223 | # Create a target which runs protoc configured with the nanopb_rpc plugin to |
| 224 | # generate the C++ proto RPC headers. |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 225 | _pw_invoke_protoc(target_name) { |
| 226 | forward_variables_from(invoker, "*", _forwarded_vars) |
| 227 | language = "raw_rpc" |
| 228 | plugin = "$dir_pw_rpc/py/pw_rpc/plugin_raw.py" |
Wyatt Hepler | 438caa0 | 2021-01-15 17:13:11 -0800 | [diff] [blame] | 229 | python_deps = [ "$dir_pw_rpc/py" ] |
Alexei Frolov | c912ea7 | 2020-10-26 08:43:27 -0700 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | # Create a library with the generated source files. |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 233 | config("$target_name._include_path") { |
| 234 | include_dirs = [ "${invoker.base_out_dir}/raw_rpc" ] |
| 235 | visibility = [ ":*" ] |
| 236 | } |
| 237 | |
Alexei Frolov | c912ea7 | 2020-10-26 08:43:27 -0700 | [diff] [blame] | 238 | pw_source_set(target_name) { |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 239 | forward_variables_from(invoker, _forwarded_vars) |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 240 | public_configs = [ ":$target_name._include_path" ] |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 241 | deps = [ ":$target_name._gen($pw_protobuf_compiler_TOOLCHAIN)" ] |
Alexei Frolov | c912ea7 | 2020-10-26 08:43:27 -0700 | [diff] [blame] | 242 | public_deps = [ |
| 243 | "$dir_pw_rpc:server", |
| 244 | "$dir_pw_rpc/raw:method_union", |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 245 | ] + invoker.deps |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 246 | public = invoker.outputs |
Alexei Frolov | c912ea7 | 2020-10-26 08:43:27 -0700 | [diff] [blame] | 247 | } |
| 248 | } |
| 249 | |
Alexei Frolov | def1471 | 2019-12-23 13:03:32 -0800 | [diff] [blame] | 250 | # Generates Go code for proto files, listing the proto output directory in the |
| 251 | # metadata variable GOPATH. Internal use only. |
Alexei Frolov | def1471 | 2019-12-23 13:03:32 -0800 | [diff] [blame] | 252 | template("_pw_go_proto_library") { |
| 253 | _proto_gopath = "$root_gen_dir/go" |
Alexei Frolov | def1471 | 2019-12-23 13:03:32 -0800 | [diff] [blame] | 254 | |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 255 | _pw_invoke_protoc(target_name) { |
| 256 | forward_variables_from(invoker, "*") |
| 257 | language = "go" |
Alexei Frolov | def1471 | 2019-12-23 13:03:32 -0800 | [diff] [blame] | 258 | metadata = { |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 259 | gopath = [ "GOPATH+=" + rebase_path(_proto_gopath) ] |
Alexei Frolov | c15a988 | 2019-12-23 14:29:02 -0800 | [diff] [blame] | 260 | external_deps = [ |
| 261 | "github.com/golang/protobuf/proto", |
| 262 | "google.golang.org/grpc", |
| 263 | ] |
Alexei Frolov | def1471 | 2019-12-23 13:03:32 -0800 | [diff] [blame] | 264 | } |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 265 | |
| 266 | # Override the default "$base_out_dir/$language" output path. |
| 267 | out_dir = "$_proto_gopath/src" |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 268 | } |
| 269 | |
| 270 | group(target_name) { |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 271 | deps = |
| 272 | invoker.deps + [ ":$target_name._gen($pw_protobuf_compiler_TOOLCHAIN)" ] |
Alexei Frolov | def1471 | 2019-12-23 13:03:32 -0800 | [diff] [blame] | 273 | } |
| 274 | } |
| 275 | |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 276 | # Generates Python code for proto files, creating a pw_python_package containing |
| 277 | # the generated files. This is internal and should not be used outside of this |
| 278 | # file. Use pw_proto_library instead. |
| 279 | template("_pw_python_proto_library") { |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 280 | _pw_invoke_protoc(target_name) { |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 281 | forward_variables_from(invoker, "*", _forwarded_vars + [ "python_package" ]) |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 282 | language = "python" |
Wyatt Hepler | 4b921c1 | 2021-03-05 15:33:29 -0800 | [diff] [blame] | 283 | python_deps = [ "$dir_pw_protobuf_compiler:protobuf_requirements" ] |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 284 | } |
| 285 | |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 286 | if (defined(invoker.python_package) && invoker.python_package != "") { |
| 287 | # If nested in a Python package, write the package's name to a file so |
| 288 | # pw_python_package can check that the dependencies are correct. |
| 289 | write_file("${invoker.base_out_dir}/python_package.txt", |
| 290 | get_label_info(invoker.python_package, "label_no_toolchain")) |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 291 | |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 292 | # If anyone attempts to depend on this Python package, print an error. |
| 293 | pw_error(target_name) { |
| 294 | _pkg = get_label_info(invoker.python_package, "label_no_toolchain") |
| 295 | message_lines = [ |
| 296 | "This proto Python package is embedded in the $_pkg Python package.", |
| 297 | "It cannot be used directly; instead, depend on $_pkg.", |
| 298 | ] |
Wyatt Hepler | d517afc | 2021-02-03 19:40:08 -0800 | [diff] [blame] | 299 | } |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 300 | foreach(subtarget, pw_python_package_subtargets) { |
| 301 | group("$target_name.$subtarget") { |
| 302 | deps = [ ":${invoker.target_name}" ] |
| 303 | } |
| 304 | } |
| 305 | } else { |
| 306 | write_file("${invoker.base_out_dir}/python_package.txt", "") |
Wyatt Hepler | d517afc | 2021-02-03 19:40:08 -0800 | [diff] [blame] | 307 | |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 308 | # Create a Python package with the generated source files. |
| 309 | pw_python_package(target_name) { |
| 310 | forward_variables_from(invoker, _forwarded_vars) |
| 311 | generate_setup = { |
| 312 | name = invoker._package_dir |
| 313 | version = "0.0.1" # TODO(hepler): Need to be able to set this verison. |
| 314 | } |
| 315 | sources = invoker.outputs |
| 316 | strip_prefix = "${invoker.base_out_dir}/python" |
| 317 | python_deps = invoker.deps |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 318 | other_deps = [ ":$target_name._gen($pw_protobuf_compiler_TOOLCHAIN)" ] |
Wyatt Hepler | c2ce524 | 2021-03-17 08:42:14 -0700 | [diff] [blame] | 319 | static_analysis = [] |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 320 | |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 321 | _pw_module_as_package = invoker.module_as_package != "" |
| 322 | } |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 323 | } |
| 324 | } |
| 325 | |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 326 | # Generates protobuf code from .proto definitions for various languages. |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 327 | # For each supported generator, creates a sub-target named: |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 328 | # |
Alexei Frolov | 8e30d46 | 2020-10-22 13:54:36 -0700 | [diff] [blame] | 329 | # <target_name>.<generator> |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 330 | # |
Wyatt Hepler | 4cdc3e7 | 2021-03-24 08:41:08 -0700 | [diff] [blame] | 331 | # GN permits using abbreviated labels when the target name matches the directory |
| 332 | # name (e.g. //foo for //foo:foo). For consistency with this, the sub-targets |
| 333 | # for each generator are aliased to the directory when the target name is the |
| 334 | # same. For example, these two labels are equivalent: |
| 335 | # |
| 336 | # //path/to/my_protos:my_protos.pwpb |
| 337 | # //path/to/my_protos:pwpb |
| 338 | # |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 339 | # pw_protobuf_library targets generate Python packages. As such, they must have |
| 340 | # globally unique package names. The first directory of the prefix or the first |
| 341 | # common directory of the sources is used as the Python package. |
| 342 | # |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 343 | # Args: |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 344 | # sources: List of input .proto files. |
| 345 | # deps: List of other pw_proto_library dependencies. |
| 346 | # inputs: Other files on which the protos depend (e.g. nanopb .options files). |
| 347 | # prefix: A prefix to add to the source protos prior to compilation. For |
| 348 | # example, a source called "foo.proto" with prefix = "nested" will be |
| 349 | # compiled with protoc as "nested/foo.proto". |
| 350 | # strip_prefix: Remove this prefix from the source protos. All source and |
| 351 | # input files must be nested under this path. |
Wyatt Hepler | 4cdc3e7 | 2021-03-24 08:41:08 -0700 | [diff] [blame] | 352 | # python_package: Label of Python package to which to add the proto modules. |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 353 | # |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 354 | template("pw_proto_library") { |
| 355 | assert(defined(invoker.sources) && invoker.sources != [], |
Wyatt Hepler | b4b73a6 | 2020-05-27 15:17:27 -0700 | [diff] [blame] | 356 | "pw_proto_library requires .proto source files") |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 357 | |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 358 | if (defined(invoker.python_module_as_package)) { |
| 359 | _module_as_package = invoker.python_module_as_package |
| 360 | |
| 361 | _must_be_one_source = invoker.sources |
| 362 | assert([ _must_be_one_source[0] ] == _must_be_one_source, |
| 363 | "'python_module_as_package' requires exactly one source file") |
| 364 | assert(_module_as_package != "", |
| 365 | "'python_module_as_package' cannot be be empty") |
| 366 | assert(string_split(_module_as_package, "/") == [ _module_as_package ], |
| 367 | "'python_module_as_package' cannot contain slashes") |
| 368 | assert(!defined(invoker.prefix), |
| 369 | "'prefix' cannot be provided with 'python_module_as_package'") |
| 370 | } else { |
| 371 | _module_as_package = "" |
| 372 | } |
| 373 | |
| 374 | if (defined(invoker.strip_prefix)) { |
| 375 | _source_root = get_path_info(invoker.strip_prefix, "abspath") |
| 376 | } else { |
| 377 | _source_root = get_path_info(".", "abspath") |
| 378 | } |
| 379 | |
| 380 | if (defined(invoker.prefix)) { |
| 381 | _prefix = invoker.prefix |
| 382 | } else { |
| 383 | _prefix = "" |
| 384 | } |
| 385 | |
Wyatt Hepler | d517afc | 2021-02-03 19:40:08 -0800 | [diff] [blame] | 386 | _common = { |
| 387 | base_target = target_name |
Wyatt Hepler | d517afc | 2021-02-03 19:40:08 -0800 | [diff] [blame] | 388 | |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 389 | # This is the output directory for all files related to this proto library. |
| 390 | # Sources are mirrored to "$base_out_dir/sources" and protoc puts outputs in |
| 391 | # "$base_out_dir/$language" by default. |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 392 | base_out_dir = |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 393 | get_label_info(":$target_name($pw_protobuf_compiler_TOOLCHAIN)", |
| 394 | "target_gen_dir") + "/$target_name.proto_library" |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 395 | |
| 396 | compile_dir = "$base_out_dir/sources" |
| 397 | |
| 398 | # Refer to the source files as the are mirrored to the output directory. |
| 399 | sources = [] |
| 400 | foreach(file, rebase_path(invoker.sources, _source_root)) { |
| 401 | sources += [ "$compile_dir/$_prefix/$file" ] |
Wyatt Hepler | d517afc | 2021-02-03 19:40:08 -0800 | [diff] [blame] | 402 | } |
| 403 | } |
| 404 | |
Wyatt Hepler | 9174147 | 2021-02-03 08:45:10 -0800 | [diff] [blame] | 405 | _package_dir = "" |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 406 | _source_names = [] |
Wyatt Hepler | 9174147 | 2021-02-03 08:45:10 -0800 | [diff] [blame] | 407 | |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 408 | # Determine the Python package name to use for these protos. If there is no |
| 409 | # prefix, the first directory the sources are nested under is used. |
| 410 | foreach(source, rebase_path(invoker.sources, _source_root)) { |
Wyatt Hepler | 9174147 | 2021-02-03 08:45:10 -0800 | [diff] [blame] | 411 | _path_components = [] |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 412 | _path_components = string_split(source, "/") |
Wyatt Hepler | 9174147 | 2021-02-03 08:45:10 -0800 | [diff] [blame] | 413 | |
| 414 | if (_package_dir == "") { |
| 415 | _package_dir = _path_components[0] |
| 416 | } else { |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 417 | assert(_prefix != "" || _path_components[0] == _package_dir, |
| 418 | "Unless 'prefix' is supplied, all .proto sources in a " + |
| 419 | "pw_proto_library must be in the same directory tree") |
Wyatt Hepler | 9174147 | 2021-02-03 08:45:10 -0800 | [diff] [blame] | 420 | } |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 421 | |
| 422 | _source_names += |
| 423 | [ get_path_info(source, "dir") + "/" + get_path_info(source, "name") ] |
Wyatt Hepler | 9174147 | 2021-02-03 08:45:10 -0800 | [diff] [blame] | 424 | } |
| 425 | |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 426 | # If the 'prefix' was supplied, use that for the package directory. |
| 427 | if (_prefix != "") { |
| 428 | _prefix_path_components = string_split(_prefix, "/") |
| 429 | _package_dir = _prefix_path_components[0] |
| 430 | } |
| 431 | |
| 432 | assert(_package_dir != "" && _package_dir != "." && _package_dir != "..", |
| 433 | "Either a 'prefix' must be specified or all sources must be nested " + |
| 434 | "under a common directory") |
| 435 | |
| 436 | # Define an action that is never executed to prevent duplicate proto packages |
| 437 | # from being declared. The target name and the output file include only the |
| 438 | # package directory, so different targets that use the same proto package name |
| 439 | # will conflict. |
| 440 | action("pw_proto_library.$_package_dir") { |
| 441 | script = "$dir_pw_build/py/pw_build/nop.py" |
Wyatt Hepler | 9174147 | 2021-02-03 08:45:10 -0800 | [diff] [blame] | 442 | visibility = [] |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 443 | |
| 444 | # Place an error message in the output path (which is never created). If the |
| 445 | # package name conflicts occur in different BUILD.gn files, this results in |
| 446 | # an otherwise cryptic Ninja error, rather than a GN error. |
| 447 | outputs = [ "$root_out_dir/ " + |
| 448 | "ERROR - Multiple pw_proto_library targets create the " + |
| 449 | "'$_package_dir' package. Change the package name by setting " + |
| 450 | "the \"prefix\" arg or move the protos to a different " + |
| 451 | "directory, then re-run gn gen." ] |
Wyatt Hepler | 9174147 | 2021-02-03 08:45:10 -0800 | [diff] [blame] | 452 | } |
| 453 | |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 454 | if (defined(invoker.deps)) { |
| 455 | _deps = invoker.deps |
| 456 | } else { |
| 457 | _deps = [] |
| 458 | } |
| 459 | |
Alexei Frolov | e19ebb8 | 2020-05-14 17:21:20 -0700 | [diff] [blame] | 460 | # For each proto target, create a file which collects the base directories of |
| 461 | # all of its dependencies to list as include paths to protoc. |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 462 | generated_file("$target_name._includes") { |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 463 | # Collect metadata from the include path files of each dependency. |
Wyatt Hepler | 4cdc3e7 | 2021-03-24 08:41:08 -0700 | [diff] [blame] | 464 | |
| 465 | deps = [] |
| 466 | foreach(dep, _deps) { |
| 467 | _base = get_label_info(dep, "label_no_toolchain") |
| 468 | deps += [ "$_base._includes(" + get_label_info(dep, "toolchain") + ")" ] |
| 469 | } |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 470 | |
Alexei Frolov | e19ebb8 | 2020-05-14 17:21:20 -0700 | [diff] [blame] | 471 | data_keys = [ "protoc_includes" ] |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 472 | outputs = [ "${_common.base_out_dir}/includes.txt" ] |
Alexei Frolov | e19ebb8 | 2020-05-14 17:21:20 -0700 | [diff] [blame] | 473 | |
| 474 | # Indicate this library's base directory for its dependents. |
| 475 | metadata = { |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 476 | protoc_includes = [ rebase_path(_common.compile_dir) ] |
Alexei Frolov | e19ebb8 | 2020-05-14 17:21:20 -0700 | [diff] [blame] | 477 | } |
| 478 | } |
| 479 | |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 480 | # Mirror the proto sources to the output directory with the prefix added. |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 481 | if (current_toolchain == pw_protobuf_compiler_TOOLCHAIN) { |
| 482 | pw_mirror_tree("$target_name._sources") { |
| 483 | source_root = _source_root |
| 484 | sources = invoker.sources |
Alexei Frolov | 05d8ef2 | 2020-06-08 10:32:29 -0700 | [diff] [blame] | 485 | |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 486 | if (defined(invoker.inputs)) { |
| 487 | sources += invoker.inputs |
| 488 | } |
| 489 | |
| 490 | directory = "${_common.compile_dir}/$_prefix" |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 491 | } |
Wyatt Hepler | f6f74f4 | 2021-04-13 19:26:20 -0700 | [diff] [blame] | 492 | } else { |
| 493 | not_needed(invoker, [ "inputs" ]) |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 494 | } |
| 495 | |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 496 | # Enumerate all of the protobuf generator targets. |
Alexei Frolov | c4b62ec | 2020-07-13 08:35:10 -0700 | [diff] [blame] | 497 | |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 498 | _pw_pwpb_proto_library("$target_name.pwpb") { |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 499 | forward_variables_from(invoker, _forwarded_vars) |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 500 | forward_variables_from(_common, "*") |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 501 | |
| 502 | deps = [] |
| 503 | foreach(dep, _deps) { |
| 504 | _base = get_label_info(dep, "label_no_toolchain") |
| 505 | deps += [ "$_base.pwpb(" + get_label_info(dep, "toolchain") + ")" ] |
| 506 | } |
| 507 | |
| 508 | outputs = [] |
| 509 | foreach(name, _source_names) { |
| 510 | outputs += [ "$base_out_dir/pwpb/$_prefix/${name}.pwpb.h" ] |
| 511 | } |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 512 | } |
| 513 | |
| 514 | if (dir_pw_third_party_nanopb != "") { |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 515 | _pw_nanopb_rpc_proto_library("$target_name.nanopb_rpc") { |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 516 | forward_variables_from(invoker, _forwarded_vars) |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 517 | forward_variables_from(_common, "*") |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 518 | |
| 519 | deps = [] |
| 520 | foreach(dep, _deps) { |
| 521 | _lbl = get_label_info(dep, "label_no_toolchain") |
| 522 | deps += [ "$_lbl.nanopb_rpc(" + get_label_info(dep, "toolchain") + ")" ] |
| 523 | } |
| 524 | |
| 525 | outputs = [] |
| 526 | foreach(name, _source_names) { |
| 527 | outputs += [ "$base_out_dir/nanopb_rpc/$_prefix/${name}.rpc.pb.h" ] |
| 528 | } |
Alexei Frolov | c4b62ec | 2020-07-13 08:35:10 -0700 | [diff] [blame] | 529 | } |
| 530 | |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 531 | _pw_nanopb_proto_library("$target_name.nanopb") { |
| 532 | forward_variables_from(invoker, _forwarded_vars) |
| 533 | forward_variables_from(_common, "*") |
| 534 | |
| 535 | deps = [] |
| 536 | foreach(dep, _deps) { |
| 537 | _base = get_label_info(dep, "label_no_toolchain") |
| 538 | deps += [ "$_base.nanopb(" + get_label_info(dep, "toolchain") + ")" ] |
Wyatt Hepler | d517afc | 2021-02-03 19:40:08 -0800 | [diff] [blame] | 539 | } |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 540 | |
| 541 | outputs = [] |
| 542 | foreach(name, _source_names) { |
| 543 | outputs += [ |
| 544 | "$base_out_dir/nanopb/$_prefix/${name}.pb.h", |
| 545 | "$base_out_dir/nanopb/$_prefix/${name}.pb.c", |
| 546 | ] |
Wyatt Hepler | d517afc | 2021-02-03 19:40:08 -0800 | [diff] [blame] | 547 | } |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 548 | } |
| 549 | } else { |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 550 | pw_error("$target_name.nanopb_rpc") { |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 551 | message = |
| 552 | "\$dir_pw_third_party_nanopb must be set to generate nanopb RPC code." |
Alexei Frolov | 8185c82 | 2020-06-12 10:45:04 -0700 | [diff] [blame] | 553 | } |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 554 | |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 555 | pw_error("$target_name.nanopb") { |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 556 | message = |
| 557 | "\$dir_pw_third_party_nanopb must be set to compile nanopb protobufs." |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 558 | } |
| 559 | } |
| 560 | |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 561 | _pw_raw_rpc_proto_library("$target_name.raw_rpc") { |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 562 | forward_variables_from(invoker, _forwarded_vars) |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 563 | forward_variables_from(_common, "*") |
| 564 | |
| 565 | deps = [] |
| 566 | foreach(dep, _deps) { |
| 567 | _base = get_label_info(dep, "label_no_toolchain") |
| 568 | deps += [ "$_base.raw_rpc(" + get_label_info(dep, "toolchain") + ")" ] |
| 569 | } |
| 570 | |
| 571 | outputs = [] |
| 572 | foreach(name, _source_names) { |
| 573 | outputs += [ "$base_out_dir/raw_rpc/$_prefix/${name}.raw_rpc.pb.h" ] |
| 574 | } |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 575 | } |
| 576 | |
Wyatt Hepler | d9336a4 | 2020-11-10 09:47:30 -0800 | [diff] [blame] | 577 | _pw_go_proto_library("$target_name.go") { |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 578 | sources = _common.sources |
| 579 | |
| 580 | deps = [] |
| 581 | foreach(dep, _deps) { |
| 582 | _base = get_label_info(dep, "label_no_toolchain") |
| 583 | deps += [ "$_base.go(" + get_label_info(dep, "toolchain") + ")" ] |
| 584 | } |
| 585 | |
| 586 | forward_variables_from(_common, "*") |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 587 | } |
| 588 | |
Alexei Frolov | 38cad0c | 2020-12-03 12:36:24 -0800 | [diff] [blame] | 589 | _pw_python_proto_library("$target_name.python") { |
Alexei Frolov | 38cad0c | 2020-12-03 12:36:24 -0800 | [diff] [blame] | 590 | forward_variables_from(_common, "*") |
Wyatt Hepler | dcfcecf | 2021-03-01 08:36:19 -0800 | [diff] [blame] | 591 | forward_variables_from(invoker, [ "python_package" ]) |
Wyatt Hepler | 752d7d3 | 2021-03-02 09:02:23 -0800 | [diff] [blame] | 592 | module_as_package = _module_as_package |
| 593 | |
| 594 | deps = [] |
| 595 | foreach(dep, _deps) { |
| 596 | _base = get_label_info(dep, "label_no_toolchain") |
| 597 | deps += [ "$_base.python(" + get_label_info(dep, "toolchain") + ")" ] |
| 598 | } |
| 599 | |
| 600 | if (module_as_package == "") { |
| 601 | _python_prefix = "$base_out_dir/python/$_prefix" |
| 602 | } else { |
| 603 | _python_prefix = "$base_out_dir/python/$module_as_package" |
| 604 | } |
| 605 | |
| 606 | outputs = [] |
| 607 | foreach(name, _source_names) { |
| 608 | outputs += [ |
| 609 | "$_python_prefix/${name}_pb2.py", |
| 610 | "$_python_prefix/${name}_pb2.pyi", |
| 611 | ] |
| 612 | } |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 613 | } |
| 614 | |
Wyatt Hepler | b4b73a6 | 2020-05-27 15:17:27 -0700 | [diff] [blame] | 615 | # All supported pw_protobuf generators. |
| 616 | _protobuf_generators = [ |
| 617 | "pwpb", |
| 618 | "nanopb", |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 619 | "nanopb_rpc", |
Alexei Frolov | c912ea7 | 2020-10-26 08:43:27 -0700 | [diff] [blame] | 620 | "raw_rpc", |
Wyatt Hepler | b4b73a6 | 2020-05-27 15:17:27 -0700 | [diff] [blame] | 621 | "go", |
Alexei Frolov | a4c0aee | 2020-12-01 13:48:48 -0800 | [diff] [blame] | 622 | "python", |
Wyatt Hepler | b4b73a6 | 2020-05-27 15:17:27 -0700 | [diff] [blame] | 623 | ] |
| 624 | |
Wyatt Hepler | 4cdc3e7 | 2021-03-24 08:41:08 -0700 | [diff] [blame] | 625 | # If the label matches the directory name, alias the subtargets to the |
| 626 | # directory (e.g. //foo:nanopb is an alias for //foo:foo.nanopb). |
| 627 | if (get_label_info(":$target_name", "name") == |
| 628 | get_path_info(get_label_info(":$target_name", "dir"), "name")) { |
Wyatt Hepler | 2c6c0ba | 2021-04-07 09:50:23 -0700 | [diff] [blame] | 629 | foreach(_generator, _protobuf_generators - [ "python" ]) { |
| 630 | group(_generator) { |
Wyatt Hepler | 4cdc3e7 | 2021-03-24 08:41:08 -0700 | [diff] [blame] | 631 | public_deps = [ ":${invoker.target_name}.$_generator" ] |
| 632 | } |
| 633 | } |
Wyatt Hepler | 2c6c0ba | 2021-04-07 09:50:23 -0700 | [diff] [blame] | 634 | |
| 635 | pw_python_group("python") { |
| 636 | python_deps = [ ":${invoker.target_name}.python" ] |
| 637 | } |
Wyatt Hepler | 4cdc3e7 | 2021-03-24 08:41:08 -0700 | [diff] [blame] | 638 | } |
| 639 | |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 640 | # If the user attempts to use the target directly instead of one of the |
Alexei Frolov | f39cd8b | 2020-04-13 17:59:20 -0700 | [diff] [blame] | 641 | # generator targets, run a script which prints a nice error message. |
Wyatt Hepler | c8e05a4 | 2020-10-19 14:49:39 -0700 | [diff] [blame] | 642 | pw_python_action(target_name) { |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 643 | script = string_join("/", |
| 644 | [ |
| 645 | dir_pw_protobuf_compiler, |
| 646 | "py", |
| 647 | "pw_protobuf_compiler", |
| 648 | "proto_target_invalid.py", |
| 649 | ]) |
| 650 | args = [ |
| 651 | "--target", |
| 652 | target_name, |
| 653 | "--dir", |
| 654 | get_path_info(".", "abspath"), |
| 655 | "--root", |
| 656 | "//", |
Alexei Frolov | b499d3f | 2020-10-28 13:00:08 -0700 | [diff] [blame] | 657 | ] + _protobuf_generators |
Alexei Frolov | 942adf0 | 2019-12-11 17:07:28 -0800 | [diff] [blame] | 658 | stamp = true |
| 659 | } |
| 660 | } |