OLD | NEW |
1 # Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 # Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 # Use of this source code is governed by a BSD-style license that can be | 2 # Use of this source code is governed by a BSD-style license that can be |
3 # found in the LICENSE file. | 3 # found in the LICENSE file. |
4 | 4 |
5 # This file is meant to be included into an target to provide a rule | 5 # This file is meant to be included into an target to provide a rule |
6 # to invoke protoc in a consistent manner. | 6 # to invoke protoc in a consistent manner. |
7 # | 7 # |
8 # To use this, create a gyp target with the following form: | 8 # To use this, create a gyp target with the following form: |
9 # { | 9 # { |
10 # 'target_name': 'my_proto_lib', | 10 # 'target_name': 'my_proto_lib', |
(...skipping 14 matching lines...) Expand all Loading... |
25 # | 25 # |
26 # The 'proto_in_dir' variable must be the relative path to the | 26 # The 'proto_in_dir' variable must be the relative path to the |
27 # directory containing the .proto files. If left out, it defaults to '.'. | 27 # directory containing the .proto files. If left out, it defaults to '.'. |
28 # | 28 # |
29 # The 'proto_out_dir' variable specifies the path suffix that output | 29 # The 'proto_out_dir' variable specifies the path suffix that output |
30 # files are generated under. Targets that gyp-depend on my_proto_lib | 30 # files are generated under. Targets that gyp-depend on my_proto_lib |
31 # will be able to include the resulting proto headers with an include | 31 # will be able to include the resulting proto headers with an include |
32 # like: | 32 # like: |
33 # #include "dir/for/my_proto_lib/foo.pb.h" | 33 # #include "dir/for/my_proto_lib/foo.pb.h" |
34 # | 34 # |
| 35 # The 'proto_relpath' variable specifies another way to provide the path |
| 36 # suffix that files are generated under. 'proto_relpath' exists because there |
| 37 # are some protos which import using qualified paths, rather than the more |
| 38 # common relative import. |
| 39 # |
| 40 # By using 'proto_relpath', projects can continue to use qualified imports |
| 41 # instead of enforcing an import style through this gypi. If provided, |
| 42 # 'proto_relpath' must have a trailing slash. |
| 43 # |
35 # Implementation notes: | 44 # Implementation notes: |
36 # A proto_out_dir of foo/bar produces | 45 # A 'proto_out_dir' of 'foo/bar', with no 'proto_relpath' provided, 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 # By setting 'proto_relpath' to 'foo/bar', with a 'proto_out_dir' of '', the |
| 50 # protos can use qualified imports instead of relative imports, |
| 51 # e.g. #import "foo/bar/file2.proto"; instead of #import "file2.proto"; |
| 52 # A 'proto_out_dir' of '', with a 'proto_relpath' of 'foo/bar/' produces: |
37 # <(SHARED_INTERMEDIATE_DIR)/protoc_out/foo/bar/{file1,file2}.pb.{cc,h} | 53 # <(SHARED_INTERMEDIATE_DIR)/protoc_out/foo/bar/{file1,file2}.pb.{cc,h} |
38 # <(SHARED_INTERMEDIATE_DIR)/pyproto/foo/bar/{file1,file2}_pb2.py | 54 # <(SHARED_INTERMEDIATE_DIR)/pyproto/foo/bar/{file1,file2}_pb2.py |
39 | 55 |
40 { | 56 { |
41 'variables': { | 57 'variables': { |
42 'protoc': '<(PRODUCT_DIR)/<(EXECUTABLE_PREFIX)protoc<(EXECUTABLE_SUFFIX)', | 58 'protoc': '<(PRODUCT_DIR)/<(EXECUTABLE_PREFIX)protoc<(EXECUTABLE_SUFFIX)', |
43 'cc_dir': '<(SHARED_INTERMEDIATE_DIR)/protoc_out/<(proto_out_dir)', | 59 'cc_dir': '<(SHARED_INTERMEDIATE_DIR)/protoc_out/<(proto_out_dir)', |
44 'py_dir': '<(PRODUCT_DIR)/pyproto/<(proto_out_dir)', | 60 'py_dir': '<(PRODUCT_DIR)/pyproto/<(proto_out_dir)', |
45 'proto_in_dir%': '.', | 61 'proto_in_dir%': '.', |
| 62 'proto_relpath%': '', |
46 }, | 63 }, |
47 'rules': [ | 64 'rules': [ |
48 { | 65 { |
49 'rule_name': 'genproto', | 66 'rule_name': 'genproto', |
50 'extension': 'proto', | 67 'extension': 'proto', |
51 'inputs': [ | 68 'inputs': [ |
52 '<(protoc)', | 69 '<(protoc)', |
53 ], | 70 ], |
54 'outputs': [ | 71 'outputs': [ |
55 '<(py_dir)/<(RULE_INPUT_ROOT)_pb2.py', | 72 '<(py_dir)/<(proto_relpath)<(RULE_INPUT_ROOT)_pb2.py', |
56 '<(cc_dir)/<(RULE_INPUT_ROOT).pb.cc', | 73 '<(cc_dir)/<(proto_relpath)<(RULE_INPUT_ROOT).pb.cc', |
57 '<(cc_dir)/<(RULE_INPUT_ROOT).pb.h', | 74 '<(cc_dir)/<(proto_relpath)<(RULE_INPUT_ROOT).pb.h', |
58 ], | 75 ], |
59 'action': [ | 76 'action': [ |
60 '<(protoc)', | 77 '<(protoc)', |
61 '--proto_path=<(proto_in_dir)', | 78 '--proto_path=<(proto_in_dir)', |
62 # Naively you'd use <(RULE_INPUT_PATH) here, but protoc requires | 79 # Naively you'd use <(RULE_INPUT_PATH) here, but protoc requires |
63 # --proto_path is a strict prefix of the path given as an argument. | 80 # --proto_path is a strict prefix of the path given as an argument. |
64 '<(proto_in_dir)/<(RULE_INPUT_ROOT)<(RULE_INPUT_EXT)', | 81 '<(proto_in_dir)/<(proto_relpath)<(RULE_INPUT_ROOT)<(RULE_INPUT_EXT)', |
65 '--cpp_out=<(cc_dir)', | 82 '--cpp_out=<(cc_dir)', |
66 '--python_out=<(py_dir)', | 83 '--python_out=<(py_dir)', |
67 ], | 84 ], |
68 'message': 'Generating C++ and Python code from <(RULE_INPUT_PATH)', | 85 'message': 'Generating C++ and Python code from <(RULE_INPUT_PATH)', |
69 'process_outputs_as_sources': 1, | 86 'process_outputs_as_sources': 1, |
70 }, | 87 }, |
71 ], | 88 ], |
72 'dependencies': [ | 89 'dependencies': [ |
73 '<(DEPTH)/third_party/protobuf/protobuf.gyp:protoc#host', | 90 '<(DEPTH)/third_party/protobuf/protobuf.gyp:protoc#host', |
74 '<(DEPTH)/third_party/protobuf/protobuf.gyp:protobuf_lite', | 91 '<(DEPTH)/third_party/protobuf/protobuf.gyp:protobuf_lite', |
75 ], | 92 ], |
76 'include_dirs': [ | 93 'include_dirs': [ |
77 '<(SHARED_INTERMEDIATE_DIR)/protoc_out', | 94 '<(SHARED_INTERMEDIATE_DIR)/protoc_out', |
78 ], | 95 ], |
79 'direct_dependent_settings': { | 96 'direct_dependent_settings': { |
80 'include_dirs': [ | 97 'include_dirs': [ |
81 '<(SHARED_INTERMEDIATE_DIR)/protoc_out', | 98 '<(SHARED_INTERMEDIATE_DIR)/protoc_out', |
82 ] | 99 ] |
83 }, | 100 }, |
84 'export_dependent_settings': [ | 101 'export_dependent_settings': [ |
85 # The generated headers reference headers within protobuf_lite, | 102 # The generated headers reference headers within protobuf_lite, |
86 # so dependencies must be able to find those headers too. | 103 # so dependencies must be able to find those headers too. |
87 '<(DEPTH)/third_party/protobuf/protobuf.gyp:protobuf_lite', | 104 '<(DEPTH)/third_party/protobuf/protobuf.gyp:protobuf_lite', |
88 ], | 105 ], |
89 # This target exports a hard dependency because it generates header | 106 # This target exports a hard dependency because it generates header |
90 # files. | 107 # files. |
91 'hard_dependency': 1, | 108 'hard_dependency': 1, |
92 } | 109 } |
OLD | NEW |