Ben Murdoch | 097c5b2 | 2016-05-18 11:27:45 +0100 | [diff] [blame] | 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 invoke protoc in a consistent manner. For Java-targets, see |
| 7 | # protoc_java.gypi. |
| 8 | # |
| 9 | # To use this, create a gyp target with the following form: |
| 10 | # { |
| 11 | # 'target_name': 'my_proto_lib', |
| 12 | # 'type': 'static_library', |
| 13 | # 'sources': [ |
| 14 | # 'foo.proto', |
| 15 | # 'bar.proto', |
| 16 | # ], |
| 17 | # 'variables': { |
| 18 | # # Optional, see below: 'proto_in_dir': '.' |
| 19 | # 'proto_out_dir': 'dir/for/my_proto_lib' |
| 20 | # }, |
| 21 | # 'includes': ['path/to/this/gypi/file'], |
| 22 | # } |
| 23 | # If necessary, you may add normal .cc files to the sources list or other gyp |
| 24 | # dependencies. The proto headers are guaranteed to be generated before any |
| 25 | # source files, even within this target, are compiled. |
| 26 | # |
| 27 | # The 'proto_in_dir' variable must be the relative path to the |
| 28 | # directory containing the .proto files. If left out, it defaults to '.'. |
| 29 | # |
| 30 | # The 'proto_out_dir' variable specifies the path suffix that output |
| 31 | # files are generated under. Targets that gyp-depend on my_proto_lib |
| 32 | # will be able to include the resulting proto headers with an include |
| 33 | # like: |
| 34 | # #include "dir/for/my_proto_lib/foo.pb.h" |
| 35 | # |
| 36 | # If you need to add an EXPORT macro to a protobuf's c++ header, set the |
| 37 | # 'cc_generator_options' variable with the value: 'dllexport_decl=FOO_EXPORT:' |
| 38 | # e.g. 'dllexport_decl=BASE_EXPORT:' |
| 39 | # |
| 40 | # It is likely you also need to #include a file for the above EXPORT macro to |
| 41 | # work. You can do so with the 'cc_include' variable. |
| 42 | # e.g. 'base/base_export.h' |
| 43 | # |
| 44 | # Implementation notes: |
| 45 | # A proto_out_dir of foo/bar produces |
| 46 | # <(SHARED_INTERMEDIATE_DIR)/protoc_out/foo/bar/{file1,file2}.pb.{cc,h} |
| 47 | # <(SHARED_INTERMEDIATE_DIR)/pyproto/foo/bar/{file1,file2}_pb2.py |
| 48 | |
| 49 | { |
| 50 | 'variables': { |
| 51 | 'protoc_wrapper': '<(DEPTH)/tools/protoc_wrapper/protoc_wrapper.py', |
| 52 | 'cc_dir': '<(SHARED_INTERMEDIATE_DIR)/protoc_out/<(proto_out_dir)', |
| 53 | 'py_dir': '<(PRODUCT_DIR)/pyproto/<(proto_out_dir)', |
| 54 | 'cc_generator_options%': '', |
| 55 | 'cc_include%': '', |
| 56 | 'proto_in_dir%': '.', |
| 57 | 'conditions': [ |
| 58 | ['use_system_protobuf==0', { |
| 59 | 'protoc': '<(PRODUCT_DIR)/<(EXECUTABLE_PREFIX)protoc<(EXECUTABLE_SUFFIX)', |
| 60 | }, { # use_system_protobuf==1 |
| 61 | 'protoc': '<!(which protoc)', |
| 62 | }], |
| 63 | ], |
| 64 | }, |
| 65 | 'rules': [ |
| 66 | { |
| 67 | 'rule_name': 'genproto', |
| 68 | 'extension': 'proto', |
| 69 | 'inputs': [ |
| 70 | '<(protoc_wrapper)', |
| 71 | '<(protoc)', |
| 72 | ], |
| 73 | 'outputs': [ |
| 74 | '<(py_dir)/<(RULE_INPUT_ROOT)_pb2.py', |
| 75 | '<(cc_dir)/<(RULE_INPUT_ROOT).pb.cc', |
| 76 | '<(cc_dir)/<(RULE_INPUT_ROOT).pb.h', |
| 77 | ], |
| 78 | 'action': [ |
| 79 | 'python', |
| 80 | '<(protoc_wrapper)', |
| 81 | '--include', |
| 82 | '<(cc_include)', |
| 83 | '--protobuf', |
| 84 | '<(cc_dir)/<(RULE_INPUT_ROOT).pb.h', |
| 85 | # Using the --arg val form (instead of --arg=val) allows gyp's msvs rule |
| 86 | # generation to correct 'val' which is a path. |
| 87 | '--proto-in-dir','<(proto_in_dir)', |
| 88 | # Naively you'd use <(RULE_INPUT_PATH) here, but protoc requires |
| 89 | # --proto_path is a strict prefix of the path given as an argument. |
| 90 | '--proto-in-file','<(RULE_INPUT_ROOT)<(RULE_INPUT_EXT)', |
| 91 | '--use-system-protobuf=<(use_system_protobuf)', |
| 92 | '--', |
| 93 | '<(protoc)', |
| 94 | '--cpp_out', '<(cc_generator_options)<(cc_dir)', |
| 95 | '--python_out', '<(py_dir)', |
| 96 | ], |
| 97 | 'message': 'Generating C++ and Python code from <(RULE_INPUT_PATH)', |
| 98 | 'process_outputs_as_sources': 1, |
| 99 | }, |
| 100 | ], |
| 101 | 'dependencies': [ |
| 102 | '<(DEPTH)/third_party/protobuf/protobuf.gyp:protoc#host', |
| 103 | '<(DEPTH)/third_party/protobuf/protobuf.gyp:protobuf_lite', |
| 104 | ], |
| 105 | 'include_dirs': [ |
| 106 | '<(SHARED_INTERMEDIATE_DIR)/protoc_out', |
| 107 | '<(DEPTH)', |
| 108 | ], |
| 109 | 'direct_dependent_settings': { |
| 110 | 'include_dirs': [ |
| 111 | '<(SHARED_INTERMEDIATE_DIR)/protoc_out', |
| 112 | '<(DEPTH)', |
| 113 | ] |
| 114 | }, |
| 115 | 'export_dependent_settings': [ |
| 116 | # The generated headers reference headers within protobuf_lite, |
| 117 | # so dependencies must be able to find those headers too. |
| 118 | '<(DEPTH)/third_party/protobuf/protobuf.gyp:protobuf_lite', |
| 119 | ], |
| 120 | # This target exports a hard dependency because it generates header |
| 121 | # files. |
| 122 | 'hard_dependency': 1, |
| 123 | } |