नियम
proto_lang_toolchain
नियम का सोर्स देखेंproto_lang_toolchain(name, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, mnemonic, output_files, plugin, plugin_format_flag, progress_message, proto_compiler, restricted_to, runtime, tags, target_compatible_with, testonly, visibility)
अगर Baज़ल का इस्तेमाल किया जा रहा है, तो कृपया https://github.com/baazbuild/rules_proto से नियम लोड करें.
इससे पता चलता है कि LANG_proto_library नियम (उदाहरण के लिए, java_proto_library
) को प्रोटो-कंपाइलर को कॉल करना चाहिए.
कुछ lang_proto_library नियम यह तय करने की अनुमति देते हैं कि कमांड लाइन फ़्लैग का इस्तेमाल करके किस टूलचेन का इस्तेमाल किया जाए. इसके लिए, उनका दस्तावेज़ पढ़ें.
आम तौर पर, आपको इस तरह के नियम तब तक नहीं लिखने चाहिए, जब तक कि आपको अपने Java कंपाइलर को बेहतर नहीं बनाना है.
कोई कंपाइलर नहीं है. प्रोटो-कंपाइलर को उस proto_library नियम से लिया जाता है जिसे हम अटैच करते हैं. इसे Blaze को कमांड-लाइन फ़्लैग के रूप में पास किया जाता है.
कई सुविधाओं का इस्तेमाल करने के लिए, Proto_library नियम पर ही किसी प्रोटो-कंपाइलर को शुरू करना ज़रूरी है.
कंपाइलर को लागू करना फ़ायदेमंद होता है, क्योंकि lang_proto_library उसी तरह काम करता है जैसा proto_library
करता है.
उदाहरण
इसका एक आसान उदाहरण यह है:
proto_lang_toolchain( name = "javalite_toolchain", command_line = "--javalite_out=shared,immutable:$(OUT)", plugin = ":javalite_plugin", runtime = ":protobuf_lite", )
तर्क
विशेषताएं | |
---|---|
name |
नाम; यह ज़रूरी है इस टारगेट के लिए यूनीक नाम. |
blacklisted_protos
|
लेबल की सूची; डिफ़ॉल्ट blacklisted_protos के srcs एट्रिब्यूट में मौजूद फ़ाइलों के लिए कोई कोड जनरेट नहीं किया जाएगा.
इसका इस्तेमाल उन .proto फ़ाइलों के लिए किया जाता है जो पहले से ही प्रोटो रनटाइम से लिंक होती हैं, जैसे कि
any.proto .
|
command_line
|
स्ट्रिंग; आवश्यक है कोड जनरेट करने के लिए, यह वैल्यू प्रोटो-कंपाइलर को दी जाएगी. सिर्फ़ इस कोड-जनरेटर/प्लग-इन के लिए खास पार्ट शामिल करें (उदाहरण के लिए, -I पैरामीटर शामिल न करें)
|
mnemonic
|
स्ट्रिंग; डिफ़ॉल्ट रूप से |
output_files
|
स्ट्रिंग; डिफ़ॉल्ट तौर पर command_line में $(OUT) को कैसे फ़ॉर्मैट किया जाता है. यह फ़ॉर्मैट किसी एक फ़ाइल के पाथ से या एक से ज़्यादा फ़ाइलों के लिए आउटपुट डायरेक्ट्री के तौर पर होता है.
संभावित वैल्यू: "single", "multiple".
|
plugin
|
लेबल; डिफ़ॉल्ट --plugin=protoc-gen-PLUGIN=<executable>.
|
plugin_format_flag
|
स्ट्रिंग; डिफ़ॉल्ट रूप से --plugin=protoc-gen-PLUGIN=<executable>.
|
progress_message
|
स्ट्रिंग; डिफ़ॉल्ट रूप से |
proto_compiler
|
लेबल; डिफ़ॉल्ट |
runtime
|
लेबल; डिफ़ॉल्ट |
proto_library
नियम का सोर्स देखेंproto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, import_prefix, licenses, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, visibility)
समर्थन नहीं होना या रुकना. इसके बजाय, कृपया https://github.com/ba इमारतोंbuild/rules_proto का इस्तेमाल करें.
proto_library
का इस्तेमाल करके, प्रोटोकॉल बफ़र की लाइब्रेरी तय करें,
जिन्हें कई भाषाओं में इस्तेमाल किया जा सकता है. proto_library
को
इस्तेमाल किए जा सकने वाले नियमों के deps
क्लॉज़ में शामिल किया जा सकता है, जैसे कि java_proto_library
.
कमांड-लाइन पर कंपाइल किए जाने पर, proto_library
foo-descriptor-set.proto.bin
नाम की एक फ़ाइल बनाता है. यह डिस्क्रिप्टर है, जो मैसेज के नियम के लिए सेट होता है. फ़ाइल, क्रम से लगाई गई FileDescriptorSet
है. इसकी जानकारी
https://developers.google.com/protocol-buffers/docs/techniques#self-description में दी गई है.
इसमें सिर्फ़ उन .proto
फ़ाइलों की जानकारी होती है जिनके बारे में proto_library
नियम में सीधे तौर पर बताया गया हो. ट्रांज़िटिव डिस्क्रिप्टर सेट का कलेक्शन, [ProtoInfo].transitive_descriptor_sets
Starlark प्रोवाइडर के ज़रिए उपलब्ध होता है.
ProtoInfo.java
में दस्तावेज़ देखें.
सुझाया गया कोड संगठन:
- हर
.proto
फ़ाइल के लिए एकproto_library
नियम. -
foo.proto
फ़ाइल,foo_proto
नाम के नियम में होगी, जो उसी पैकेज में मौजूद है. -
foo_proto
नाम केproto_library
को रैप करने वाले[language]_proto_library
कोfoo_[language]_proto
कहा जाना चाहिए और यह उसी पैकेज में मौजूद होना चाहिए.
तर्क
विशेषताएं | |
---|---|
name |
नाम; ज़रूरी है इस टारगेट के लिए यूनीक नाम. |
deps
|
लेबल की सूची; डिफ़ॉल्ट proto_library के उन अन्य नियमों की सूची जिन पर टारगेट निर्भर करता है.
proto_library सिर्फ़ अन्य
proto_library टारगेट पर निर्भर हो सकता है.
ऐसा हो सकता है कि यह भाषा के हिसाब से लाइब्रेरी पर निर्भर न हो.
|
srcs
|
लेबल की सूची; डिफ़ॉल्ट .proto और .protodevel फ़ाइलों की सूची. आम तौर पर, यह सूची खाली नहीं होती है. एक इस्तेमाल का उदाहरण,
alias-library होता है जिसमें srcs खाली रह सकता है. यह एक proto_library नियम है जिसमें deps में एक या एक से ज़्यादा, proto_library है.
इस पैटर्न का इस्तेमाल, किसी सार्वजनिक एपीआई को किसी ऐसे नाम से एक्सपोर्ट करने के लिए किया जा सकता है जो हमेशा मौजूद रहता है.
|
allow_exports
|
लेबल; डिफ़ॉल्ट |
exports
|
लेबल की सूची; डिफ़ॉल्ट |
import_prefix
|
स्ट्रिंग; डिफ़ॉल्ट तौर पर सेट होने पर, इस नियम के इस प्रीफ़िक्स को जोड़ने से पहले, |
strip_import_prefix
|
स्ट्रिंग; डिफ़ॉल्ट रूप से अगर नीति को सेट किया जाता है, तो इस नियम के अगर यह रिलेटिव पाथ है (स्लैश से शुरू नहीं होता), तो इसे पैकेज के हिसाब से रिलेटिव पाथ माना जाता है. अगर यह सटीक है, तो इसे रिपॉज़िटरी-रिलेटिव पाथ माना जाता है. इस प्रीफ़िक्स को हटाने के बाद, |