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