1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc. All rights reserved.
3 // https://developers.google.com/protocol-buffers/
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
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
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.
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.
31 // Author: kenton@google.com (Kenton Varda)
33 // WARNING: The plugin interface is currently EXPERIMENTAL and is subject to
36 // protoc (aka the Protocol Compiler) can be extended via plugins. A plugin is
37 // just a program that reads a CodeGeneratorRequest from stdin and writes a
38 // CodeGeneratorResponse to stdout.
40 // Plugins written using C++ can use google/protobuf/compiler/plugin.h instead
41 // of dealing with the raw protocol defined here.
43 // A plugin executable needs only to be placed somewhere in the path. The
44 // plugin should be named "protoc-gen-$NAME", and will then be used when the
45 // flag "--${NAME}_out" is passed to protoc.
48 package google.protobuf.compiler;
49 option java_package = "com.google.protobuf.compiler";
50 option java_outer_classname = "PluginProtos";
52 import "google/protobuf/descriptor.proto";
54 // An encoded CodeGeneratorRequest is written to the plugin's stdin.
55 message CodeGeneratorRequest {
56 // The .proto files that were explicitly listed on the command-line. The
57 // code generator should generate code only for these files. Each file's
58 // descriptor will be included in proto_file, below.
59 repeated string file_to_generate = 1;
61 // The generator parameter passed on the command-line.
62 optional string parameter = 2;
64 // FileDescriptorProtos for all files in files_to_generate and everything
65 // they import. The files will appear in topological order, so each file
66 // appears before any file that imports it.
68 // protoc guarantees that all proto_files will be written after
69 // the fields above, even though this is not technically guaranteed by the
70 // protobuf wire format. This theoretically could allow a plugin to stream
71 // in the FileDescriptorProtos and handle them one by one rather than read
72 // the entire set into memory at once. However, as of this writing, this
73 // is not similarly optimized on protoc's end -- it will store all fields in
74 // memory at once before sending them to the plugin.
75 repeated FileDescriptorProto proto_file = 15;
78 // The plugin writes an encoded CodeGeneratorResponse to stdout.
79 message CodeGeneratorResponse {
80 // Error message. If non-empty, code generation failed. The plugin process
81 // should exit with status code zero even if it reports an error in this way.
83 // This should be used to indicate errors in .proto files which prevent the
84 // code generator from generating correct code. Errors which indicate a
85 // problem in protoc itself -- such as the input CodeGeneratorRequest being
86 // unparseable -- should be reported by writing a message to stderr and
87 // exiting with a non-zero status code.
88 optional string error = 1;
90 // Represents a single generated file.
92 // The file name, relative to the output directory. The name must not
93 // contain "." or ".." components and must be relative, not be absolute (so,
94 // the file cannot lie outside the output directory). "/" must be used as
95 // the path separator, not "\".
97 // If the name is omitted, the content will be appended to the previous
98 // file. This allows the generator to break large files into small chunks,
99 // and allows the generated text to be streamed back to protoc so that large
100 // files need not reside completely in memory at one time. Note that as of
101 // this writing protoc does not optimize for this -- it will read the entire
102 // CodeGeneratorResponse before writing files to disk.
103 optional string name = 1;
105 // If non-empty, indicates that the named file should already exist, and the
106 // content here is to be inserted into that file at a defined insertion
107 // point. This feature allows a code generator to extend the output
108 // produced by another code generator. The original generator may provide
109 // insertion points by placing special annotations in the file that look
111 // @@protoc_insertion_point(NAME)
112 // The annotation can have arbitrary text before and after it on the line,
113 // which allows it to be placed in a comment. NAME should be replaced with
114 // an identifier naming the point -- this is what other generators will use
115 // as the insertion_point. Code inserted at this point will be placed
116 // immediately above the line containing the insertion point (thus multiple
117 // insertions to the same point will come out in the order they were added).
118 // The double-@ is intended to make it unlikely that the generated code
119 // could contain things that look like insertion points by accident.
121 // For example, the C++ code generator places the following line in the
122 // .pb.h files that it generates:
123 // // @@protoc_insertion_point(namespace_scope)
124 // This line appears within the scope of the file's package namespace, but
125 // outside of any particular class. Another plugin can then specify the
126 // insertion_point "namespace_scope" to generate additional classes or
127 // other declarations that should be placed in this scope.
129 // Note that if the line containing the insertion point begins with
130 // whitespace, the same whitespace will be added to every line of the
131 // inserted text. This is useful for languages like Python, where
132 // indentation matters. In these languages, the insertion point comment
133 // should be indented the same amount as any inserted code will need to be
134 // in order to work correctly in that context.
136 // The code generator that generates the initial file and the one which
137 // inserts into it must both run as part of a single invocation of protoc.
138 // Code generators are executed in the order in which they appear on the
141 // If |insertion_point| is present, |name| must also be present.
142 optional string insertion_point = 2;
144 // The file contents.
145 optional string content = 15;
147 repeated File file = 15;