@ohos-ports/protoc 36.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,11 @@
1
+ protoc
2
+ ======
3
+
4
+ This package provides the Protobuf compiler `protoc` <!-- inject: release.tag_name -->v36.0<!-- end -->.
5
+
6
+ ```shell script
7
+ npm install --save-dev protoc
8
+ npx protoc --version
9
+ ```
10
+
11
+ This is an unofficial distribution of the protoc binary from https://github.com/protocolbuffers/protobuf/releases.
package/assets.json ADDED
@@ -0,0 +1,50 @@
1
+ [
2
+ {
3
+ "name": "protoc-36.0-linux-aarch_64.zip",
4
+ "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v36.0/protoc-36.0-linux-aarch_64.zip",
5
+ "platform": "linux",
6
+ "arch": "arm64",
7
+ "dotExe": false,
8
+ "executable": "protoc-linux-aarch_64"
9
+ },
10
+ {
11
+ "name": "protoc-36.0-linux-x86_64.zip",
12
+ "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v36.0/protoc-36.0-linux-x86_64.zip",
13
+ "platform": "linux",
14
+ "arch": "x64",
15
+ "dotExe": false,
16
+ "executable": "protoc-linux-x86_64"
17
+ },
18
+ {
19
+ "name": "protoc-36.0-osx-aarch_64.zip",
20
+ "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v36.0/protoc-36.0-osx-aarch_64.zip",
21
+ "platform": "darwin",
22
+ "arch": "arm64",
23
+ "dotExe": false,
24
+ "executable": "protoc-osx-aarch_64"
25
+ },
26
+ {
27
+ "name": "protoc-36.0-osx-x86_64.zip",
28
+ "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v36.0/protoc-36.0-osx-x86_64.zip",
29
+ "platform": "darwin",
30
+ "arch": "x64",
31
+ "dotExe": false,
32
+ "executable": "protoc-osx-x86_64"
33
+ },
34
+ {
35
+ "name": "protoc-36.0-win64.zip",
36
+ "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v36.0/protoc-36.0-win64.zip",
37
+ "platform": "win32",
38
+ "arch": "x64",
39
+ "dotExe": true,
40
+ "executable": "protoc-win64.exe"
41
+ },
42
+ {
43
+ "name": "protoc-36.0-openharmony-arm64.zip",
44
+ "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v36.0/protoc-36.0-openharmony-arm64.zip",
45
+ "platform": "openharmony",
46
+ "arch": "arm64",
47
+ "dotExe": false,
48
+ "executable": "protoc-openharmony-arm64"
49
+ }
50
+ ]
Binary file
Binary file
Binary file
Binary file
Binary file
@@ -0,0 +1,106 @@
1
+ // Protocol Buffers - Google's data interchange format
2
+ // Copyright 2008 Google Inc. All rights reserved.
3
+ // https://developers.google.com/protocol-buffers/
4
+ //
5
+ // Redistribution and use in source and binary forms, with or without
6
+ // modification, are permitted provided that the following conditions are
7
+ // met:
8
+ //
9
+ // * Redistributions of source code must retain the above copyright
10
+ // notice, this list of conditions and the following disclaimer.
11
+ // * Redistributions in binary form must reproduce the above
12
+ // copyright notice, this list of conditions and the following disclaimer
13
+ // in the documentation and/or other materials provided with the
14
+ // distribution.
15
+ // * Neither the name of Google Inc. nor the names of its
16
+ // contributors may be used to endorse or promote products derived from
17
+ // this software without specific prior written permission.
18
+ //
19
+ // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20
+ // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21
+ // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22
+ // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23
+ // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24
+ // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25
+ // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26
+ // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27
+ // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
+ // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
+
31
+ syntax = "proto3";
32
+
33
+ package google.protobuf;
34
+
35
+ option go_package = "google.golang.org/protobuf/types/known/anypb";
36
+ option java_package = "com.google.protobuf";
37
+ option java_outer_classname = "AnyProto";
38
+ option java_multiple_files = true;
39
+ option objc_class_prefix = "GPB";
40
+ option csharp_namespace = "Google.Protobuf.WellKnownTypes";
41
+
42
+ // `Any` contains an arbitrary serialized protocol buffer message along with a
43
+ // URL that describes the type of the serialized message.
44
+ //
45
+ // In its binary encoding, an `Any` is an ordinary message; but in other wire
46
+ // forms like JSON, it has a special encoding. The format of the type URL is
47
+ // described on the `type_url` field.
48
+ //
49
+ // Protobuf APIs provide utilities to interact with `Any` values:
50
+ //
51
+ // - A 'pack' operation accepts a message and constructs a generic `Any` wrapper
52
+ // around it.
53
+ // - An 'unpack' operation reads the content of an `Any` message, either into an
54
+ // existing message or a new one. Unpack operations must check the type of the
55
+ // value they unpack against the declared `type_url`.
56
+ // - An 'is' operation decides whether an `Any` contains a message of the given
57
+ // type, i.e. whether it can 'unpack' that type.
58
+ //
59
+ // The JSON format representation of an `Any` follows one of these cases:
60
+ //
61
+ // - For types without special-cased JSON encodings, the JSON format
62
+ // representation of the `Any` is the same as that of the message, with an
63
+ // additional `@type` field which contains the type URL.
64
+ // - For types with special-cased JSON encodings (typically called 'well-known'
65
+ // types, listed in https://protobuf.dev/programming-guides/json/#any), the
66
+ // JSON format representation has a key `@type` which contains the type URL
67
+ // and a key `value` which contains the JSON-serialized value.
68
+ //
69
+ // The text format representation of an `Any` is like a message with one field
70
+ // whose name is the type URL in brackets. For example, an `Any` containing a
71
+ // `foo.Bar` message may be written `[type.googleapis.com/foo.Bar] { a: 2 }`.
72
+ message Any {
73
+ // Identifies the type of the serialized Protobuf message with a URI reference
74
+ // consisting of a prefix ending in a slash and the fully-qualified type name.
75
+ //
76
+ // Example: type.googleapis.com/google.protobuf.StringValue
77
+ //
78
+ // This string must contain at least one `/` character, and the content after
79
+ // the last `/` must be the fully-qualified name of the type in canonical
80
+ // form, without a leading dot. Do not write a scheme on these URI references
81
+ // so that clients do not attempt to contact them.
82
+ //
83
+ // The prefix is arbitrary and Protobuf implementations are expected to
84
+ // simply strip off everything up to and including the last `/` to identify
85
+ // the type. `type.googleapis.com/` is a common default prefix that some
86
+ // legacy implementations require. This prefix does not indicate the origin of
87
+ // the type, and URIs containing it are not expected to respond to any
88
+ // requests.
89
+ //
90
+ // All type URL strings must be legal URI references with the additional
91
+ // restriction (for the text format) that the content of the reference
92
+ // must consist only of alphanumeric characters, percent-encoded escapes, and
93
+ // characters in the following set (not including the outer backticks):
94
+ // `/-.~_!$&()*+,;=`. Despite our allowing percent encodings, implementations
95
+ // should not unescape them to prevent confusion with existing parsers. For
96
+ // example, `type.googleapis.com%2FFoo` should be rejected.
97
+ //
98
+ // In the original design of `Any`, the possibility of launching a type
99
+ // resolution service at these type URLs was considered but Protobuf never
100
+ // implemented one and considers contacting these URLs to be problematic and
101
+ // a potential security issue. Do not attempt to contact type URLs.
102
+ string type_url = 1;
103
+
104
+ // Holds a Protobuf serialization of the type described by type_url.
105
+ bytes value = 2;
106
+ }
@@ -0,0 +1,229 @@
1
+ // Protocol Buffers - Google's data interchange format
2
+ // Copyright 2008 Google Inc. All rights reserved.
3
+ // https://developers.google.com/protocol-buffers/
4
+ //
5
+ // Redistribution and use in source and binary forms, with or without
6
+ // modification, are permitted provided that the following conditions are
7
+ // met:
8
+ //
9
+ // * Redistributions of source code must retain the above copyright
10
+ // notice, this list of conditions and the following disclaimer.
11
+ // * Redistributions in binary form must reproduce the above
12
+ // copyright notice, this list of conditions and the following disclaimer
13
+ // in the documentation and/or other materials provided with the
14
+ // distribution.
15
+ // * Neither the name of Google Inc. nor the names of its
16
+ // contributors may be used to endorse or promote products derived from
17
+ // this software without specific prior written permission.
18
+ //
19
+ // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20
+ // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21
+ // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22
+ // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23
+ // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24
+ // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25
+ // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26
+ // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27
+ // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
+ // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
+
31
+ syntax = "proto3";
32
+
33
+ package google.protobuf;
34
+
35
+ import "google/protobuf/source_context.proto";
36
+ import "google/protobuf/type.proto";
37
+
38
+ option java_package = "com.google.protobuf";
39
+ option java_outer_classname = "ApiProto";
40
+ option java_multiple_files = true;
41
+ option objc_class_prefix = "GPB";
42
+ option csharp_namespace = "Google.Protobuf.WellKnownTypes";
43
+ option go_package = "google.golang.org/protobuf/types/known/apipb";
44
+
45
+ // Api is a light-weight descriptor for an API Interface.
46
+ //
47
+ // Interfaces are also described as "protocol buffer services" in some contexts,
48
+ // such as by the "service" keyword in a .proto file, but they are different
49
+ // from API Services, which represent a concrete implementation of an interface
50
+ // as opposed to simply a description of methods and bindings. They are also
51
+ // sometimes simply referred to as "APIs" in other contexts, such as the name of
52
+ // this message itself. See https://cloud.google.com/apis/design/glossary for
53
+ // detailed terminology.
54
+ //
55
+ // New usages of this message as an alternative to ServiceDescriptorProto are
56
+ // strongly discouraged. This message does not reliability preserve all
57
+ // information necessary to model the schema and preserve semantics. Instead
58
+ // make use of FileDescriptorSet which preserves the necessary information.
59
+ message Api {
60
+ // The fully qualified name of this interface, including package name
61
+ // followed by the interface's simple name.
62
+ string name = 1;
63
+
64
+ // The methods of this interface, in unspecified order.
65
+ repeated Method methods = 2;
66
+
67
+ // Any metadata attached to the interface.
68
+ repeated Option options = 3;
69
+
70
+ // A version string for this interface. If specified, must have the form
71
+ // `major-version.minor-version`, as in `1.10`. If the minor version is
72
+ // omitted, it defaults to zero. If the entire version field is empty, the
73
+ // major version is derived from the package name, as outlined below. If the
74
+ // field is not empty, the version in the package name will be verified to be
75
+ // consistent with what is provided here.
76
+ //
77
+ // The versioning schema uses [semantic
78
+ // versioning](http://semver.org) where the major version number
79
+ // indicates a breaking change and the minor version an additive,
80
+ // non-breaking change. Both version numbers are signals to users
81
+ // what to expect from different versions, and should be carefully
82
+ // chosen based on the product plan.
83
+ //
84
+ // The major version is also reflected in the package name of the
85
+ // interface, which must end in `v<major-version>`, as in
86
+ // `google.feature.v1`. For major versions 0 and 1, the suffix can
87
+ // be omitted. Zero major versions must only be used for
88
+ // experimental, non-GA interfaces.
89
+ //
90
+ string version = 4;
91
+
92
+ // Source context for the protocol buffer service represented by this
93
+ // message.
94
+ SourceContext source_context = 5;
95
+
96
+ // Included interfaces. See [Mixin][].
97
+ repeated Mixin mixins = 6;
98
+
99
+ // The source syntax of the service.
100
+ Syntax syntax = 7;
101
+
102
+ // The source edition string, only valid when syntax is SYNTAX_EDITIONS.
103
+ string edition = 8;
104
+ }
105
+
106
+ // Method represents a method of an API interface.
107
+ //
108
+ // New usages of this message as an alternative to MethodDescriptorProto are
109
+ // strongly discouraged. This message does not reliability preserve all
110
+ // information necessary to model the schema and preserve semantics. Instead
111
+ // make use of FileDescriptorSet which preserves the necessary information.
112
+ message Method {
113
+ // The simple name of this method.
114
+ string name = 1;
115
+
116
+ // A URL of the input message type.
117
+ string request_type_url = 2;
118
+
119
+ // If true, the request is streamed.
120
+ bool request_streaming = 3;
121
+
122
+ // The URL of the output message type.
123
+ string response_type_url = 4;
124
+
125
+ // If true, the response is streamed.
126
+ bool response_streaming = 5;
127
+
128
+ // Any metadata attached to the method.
129
+ repeated Option options = 6;
130
+
131
+ // The source syntax of this method.
132
+ //
133
+ // This field should be ignored, instead the syntax should be inherited from
134
+ // Api. This is similar to Field and EnumValue.
135
+ Syntax syntax = 7 [deprecated = true];
136
+
137
+ // The source edition string, only valid when syntax is SYNTAX_EDITIONS.
138
+ //
139
+ // This field should be ignored, instead the edition should be inherited from
140
+ // Api. This is similar to Field and EnumValue.
141
+ string edition = 8 [deprecated = true];
142
+ }
143
+
144
+ // Declares an API Interface to be included in this interface. The including
145
+ // interface must redeclare all the methods from the included interface, but
146
+ // documentation and options are inherited as follows:
147
+ //
148
+ // - If after comment and whitespace stripping, the documentation
149
+ // string of the redeclared method is empty, it will be inherited
150
+ // from the original method.
151
+ //
152
+ // - Each annotation belonging to the service config (http,
153
+ // visibility) which is not set in the redeclared method will be
154
+ // inherited.
155
+ //
156
+ // - If an http annotation is inherited, the path pattern will be
157
+ // modified as follows. Any version prefix will be replaced by the
158
+ // version of the including interface plus the [root][] path if
159
+ // specified.
160
+ //
161
+ // Example of a simple mixin:
162
+ //
163
+ // package google.acl.v1;
164
+ // service AccessControl {
165
+ // // Get the underlying ACL object.
166
+ // rpc GetAcl(GetAclRequest) returns (Acl) {
167
+ // option (google.api.http).get = "/v1/{resource=**}:getAcl";
168
+ // }
169
+ // }
170
+ //
171
+ // package google.storage.v2;
172
+ // service Storage {
173
+ // rpc GetAcl(GetAclRequest) returns (Acl);
174
+ //
175
+ // // Get a data record.
176
+ // rpc GetData(GetDataRequest) returns (Data) {
177
+ // option (google.api.http).get = "/v2/{resource=**}";
178
+ // }
179
+ // }
180
+ //
181
+ // Example of a mixin configuration:
182
+ //
183
+ // apis:
184
+ // - name: google.storage.v2.Storage
185
+ // mixins:
186
+ // - name: google.acl.v1.AccessControl
187
+ //
188
+ // The mixin construct implies that all methods in `AccessControl` are
189
+ // also declared with same name and request/response types in
190
+ // `Storage`. A documentation generator or annotation processor will
191
+ // see the effective `Storage.GetAcl` method after inheriting
192
+ // documentation and annotations as follows:
193
+ //
194
+ // service Storage {
195
+ // // Get the underlying ACL object.
196
+ // rpc GetAcl(GetAclRequest) returns (Acl) {
197
+ // option (google.api.http).get = "/v2/{resource=**}:getAcl";
198
+ // }
199
+ // ...
200
+ // }
201
+ //
202
+ // Note how the version in the path pattern changed from `v1` to `v2`.
203
+ //
204
+ // If the `root` field in the mixin is specified, it should be a
205
+ // relative path under which inherited HTTP paths are placed. Example:
206
+ //
207
+ // apis:
208
+ // - name: google.storage.v2.Storage
209
+ // mixins:
210
+ // - name: google.acl.v1.AccessControl
211
+ // root: acls
212
+ //
213
+ // This implies the following inherited HTTP annotation:
214
+ //
215
+ // service Storage {
216
+ // // Get the underlying ACL object.
217
+ // rpc GetAcl(GetAclRequest) returns (Acl) {
218
+ // option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
219
+ // }
220
+ // ...
221
+ // }
222
+ message Mixin {
223
+ // The fully qualified name of the interface which is included.
224
+ string name = 1;
225
+
226
+ // If non-empty specifies a path under which inherited HTTP paths
227
+ // are rooted.
228
+ string root = 2;
229
+ }
@@ -0,0 +1,36 @@
1
+ // Protocol Buffers - Google's data interchange format
2
+ // Copyright 2026 Google Inc. All rights reserved.
3
+ //
4
+ // Use of this source code is governed by a BSD-style
5
+ // license that can be found in the LICENSE file or at
6
+ // https://developers.google.com/open-source/licenses/bsd
7
+
8
+ syntax = "proto2";
9
+
10
+ package pb;
11
+
12
+ option csharp_namespace = "Google.Protobuf.Reflection";
13
+ option java_multiple_files = true;
14
+ option java_outer_classname = "CSharpFeaturesOuterClass";
15
+
16
+ import "google/protobuf/descriptor.proto";
17
+
18
+ extend google.protobuf.FeatureSet {
19
+ optional CSharpFeatures csharp = 1004;
20
+ }
21
+
22
+ message CSharpFeatures {
23
+ // Whether the generated files should have nullable reference type annotations.
24
+ // When enabled, the generated C# code includes `#nullable enable annotations`
25
+ // and annotates message-typed properties and certain parameters with `?`.
26
+ optional bool nullable_reference_types = 1 [
27
+ retention = RETENTION_RUNTIME,
28
+ targets = TARGET_TYPE_FIELD,
29
+ targets = TARGET_TYPE_MESSAGE,
30
+ targets = TARGET_TYPE_FILE,
31
+ feature_support = {
32
+ edition_introduced: EDITION_2026,
33
+ },
34
+ edition_defaults = { edition: EDITION_LEGACY, value: "false" }
35
+ ];
36
+ }
@@ -0,0 +1,180 @@
1
+ // Protocol Buffers - Google's data interchange format
2
+ // Copyright 2008 Google Inc. All rights reserved.
3
+ //
4
+ // Use of this source code is governed by a BSD-style
5
+ // license that can be found in the LICENSE file or at
6
+ // https://developers.google.com/open-source/licenses/bsd
7
+
8
+ // Author: kenton@google.com (Kenton Varda)
9
+ //
10
+ // protoc (aka the Protocol Compiler) can be extended via plugins. A plugin is
11
+ // just a program that reads a CodeGeneratorRequest from stdin and writes a
12
+ // CodeGeneratorResponse to stdout.
13
+ //
14
+ // Plugins written using C++ can use google/protobuf/compiler/plugin.h instead
15
+ // of dealing with the raw protocol defined here.
16
+ //
17
+ // A plugin executable needs only to be placed somewhere in the path. The
18
+ // plugin should be named "protoc-gen-$NAME", and will then be used when the
19
+ // flag "--${NAME}_out" is passed to protoc.
20
+
21
+ syntax = "proto2";
22
+
23
+ package google.protobuf.compiler;
24
+ option java_package = "com.google.protobuf.compiler";
25
+ option java_outer_classname = "PluginProtos";
26
+
27
+ import "google/protobuf/descriptor.proto";
28
+
29
+ option csharp_namespace = "Google.Protobuf.Compiler";
30
+ option go_package = "google.golang.org/protobuf/types/pluginpb";
31
+
32
+ // The version number of protocol compiler.
33
+ message Version {
34
+ optional int32 major = 1;
35
+ optional int32 minor = 2;
36
+ optional int32 patch = 3;
37
+ // A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
38
+ // be empty for mainline stable releases.
39
+ optional string suffix = 4;
40
+ }
41
+
42
+ // An encoded CodeGeneratorRequest is written to the plugin's stdin.
43
+ message CodeGeneratorRequest {
44
+ // The .proto files that were explicitly listed on the command-line. The
45
+ // code generator should generate code only for these files. Each file's
46
+ // descriptor will be included in proto_file, below.
47
+ repeated string file_to_generate = 1;
48
+
49
+ // The generator parameter passed on the command-line.
50
+ optional string parameter = 2;
51
+
52
+ // FileDescriptorProtos for all files in files_to_generate and everything
53
+ // they import. The files will appear in topological order, so each file
54
+ // appears before any file that imports it.
55
+ //
56
+ // Note: the files listed in files_to_generate will include runtime-retention
57
+ // options only, but all other files will include source-retention options.
58
+ // The source_file_descriptors field below is available in case you need
59
+ // source-retention options for files_to_generate.
60
+ //
61
+ // protoc guarantees that all proto_files will be written after
62
+ // the fields above, even though this is not technically guaranteed by the
63
+ // protobuf wire format. This theoretically could allow a plugin to stream
64
+ // in the FileDescriptorProtos and handle them one by one rather than read
65
+ // the entire set into memory at once. However, as of this writing, this
66
+ // is not similarly optimized on protoc's end -- it will store all fields in
67
+ // memory at once before sending them to the plugin.
68
+ //
69
+ // Type names of fields and extensions in the FileDescriptorProto are always
70
+ // fully qualified.
71
+ repeated FileDescriptorProto proto_file = 15;
72
+
73
+ // File descriptors with all options, including source-retention options.
74
+ // These descriptors are only provided for the files listed in
75
+ // files_to_generate.
76
+ repeated FileDescriptorProto source_file_descriptors = 17;
77
+
78
+ // The version number of protocol compiler.
79
+ optional Version compiler_version = 3;
80
+ }
81
+
82
+ // The plugin writes an encoded CodeGeneratorResponse to stdout.
83
+ message CodeGeneratorResponse {
84
+ // Error message. If non-empty, code generation failed. The plugin process
85
+ // should exit with status code zero even if it reports an error in this way.
86
+ //
87
+ // This should be used to indicate errors in .proto files which prevent the
88
+ // code generator from generating correct code. Errors which indicate a
89
+ // problem in protoc itself -- such as the input CodeGeneratorRequest being
90
+ // unparseable -- should be reported by writing a message to stderr and
91
+ // exiting with a non-zero status code.
92
+ optional string error = 1;
93
+
94
+ // A bitmask of supported features that the code generator supports.
95
+ // This is a bitwise "or" of values from the Feature enum.
96
+ optional uint64 supported_features = 2;
97
+
98
+ // Sync with code_generator.h.
99
+ enum Feature {
100
+ FEATURE_NONE = 0;
101
+ FEATURE_PROTO3_OPTIONAL = 1;
102
+ FEATURE_SUPPORTS_EDITIONS = 2;
103
+ }
104
+
105
+ // The minimum edition this plugin supports. This will be treated as an
106
+ // Edition enum, but we want to allow unknown values. It should be specified
107
+ // according the edition enum value, *not* the edition number. Only takes
108
+ // effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.
109
+ optional int32 minimum_edition = 3;
110
+
111
+ // The maximum edition this plugin supports. This will be treated as an
112
+ // Edition enum, but we want to allow unknown values. It should be specified
113
+ // according the edition enum value, *not* the edition number. Only takes
114
+ // effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.
115
+ optional int32 maximum_edition = 4;
116
+
117
+ // Represents a single generated file.
118
+ message File {
119
+ // The file name, relative to the output directory. The name must not
120
+ // contain "." or ".." components and must be relative, not be absolute (so,
121
+ // the file cannot lie outside the output directory). "/" must be used as
122
+ // the path separator, not "\".
123
+ //
124
+ // If the name is omitted, the content will be appended to the previous
125
+ // file. This allows the generator to break large files into small chunks,
126
+ // and allows the generated text to be streamed back to protoc so that large
127
+ // files need not reside completely in memory at one time. Note that as of
128
+ // this writing protoc does not optimize for this -- it will read the entire
129
+ // CodeGeneratorResponse before writing files to disk.
130
+ optional string name = 1;
131
+
132
+ // If non-empty, indicates that the named file should already exist, and the
133
+ // content here is to be inserted into that file at a defined insertion
134
+ // point. This feature allows a code generator to extend the output
135
+ // produced by another code generator. The original generator may provide
136
+ // insertion points by placing special annotations in the file that look
137
+ // like:
138
+ // @@protoc_insertion_point(NAME)
139
+ // The annotation can have arbitrary text before and after it on the line,
140
+ // which allows it to be placed in a comment. NAME should be replaced with
141
+ // an identifier naming the point -- this is what other generators will use
142
+ // as the insertion_point. Code inserted at this point will be placed
143
+ // immediately above the line containing the insertion point (thus multiple
144
+ // insertions to the same point will come out in the order they were added).
145
+ // The double-@ is intended to make it unlikely that the generated code
146
+ // could contain things that look like insertion points by accident.
147
+ //
148
+ // For example, the C++ code generator places the following line in the
149
+ // .pb.h files that it generates:
150
+ // // @@protoc_insertion_point(namespace_scope)
151
+ // This line appears within the scope of the file's package namespace, but
152
+ // outside of any particular class. Another plugin can then specify the
153
+ // insertion_point "namespace_scope" to generate additional classes or
154
+ // other declarations that should be placed in this scope.
155
+ //
156
+ // Note that if the line containing the insertion point begins with
157
+ // whitespace, the same whitespace will be added to every line of the
158
+ // inserted text. This is useful for languages like Python, where
159
+ // indentation matters. In these languages, the insertion point comment
160
+ // should be indented the same amount as any inserted code will need to be
161
+ // in order to work correctly in that context.
162
+ //
163
+ // The code generator that generates the initial file and the one which
164
+ // inserts into it must both run as part of a single invocation of protoc.
165
+ // Code generators are executed in the order in which they appear on the
166
+ // command line.
167
+ //
168
+ // If |insertion_point| is present, |name| must also be present.
169
+ optional string insertion_point = 2;
170
+
171
+ // The file contents.
172
+ optional string content = 15;
173
+
174
+ // Information describing the file content being inserted. If an insertion
175
+ // point is used, this information will be appropriately offset and inserted
176
+ // into the code generation metadata for the generated files.
177
+ optional GeneratedCodeInfo generated_code_info = 16;
178
+ }
179
+ repeated File file = 15;
180
+ }