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// Author: benjy@google.com (Benjy Weinberger) 32// Based on original Protocol Buffers design by 33// Sanjay Ghemawat, Jeff Dean, and others. 34// 35// A proto file used to test the "custom options" feature of google.protobuf. 36 37syntax = "proto2"; 38 39// Some generic_services option(s) added automatically. 40// See: http://go/proto2-generic-services-default 41option cc_generic_services = true; // auto-added 42option java_generic_services = true; // auto-added 43option py_generic_services = true; 44 45// A custom file option (defined below). 46option (file_opt1) = 9876543210; 47 48import "google/protobuf/descriptor.proto"; 49 50// We don't put this in a package within proto2 because we need to make sure 51// that the generated code doesn't depend on being in the proto2 namespace. 52package protobuf_unittest; 53 54 55// Some simple test custom options of various types. 56 57extend google.protobuf.FileOptions { 58 optional uint64 file_opt1 = 7736974; 59} 60 61extend google.protobuf.MessageOptions { 62 optional int32 message_opt1 = 7739036; 63} 64 65extend google.protobuf.FieldOptions { 66 optional fixed64 field_opt1 = 7740936; 67 // This is useful for testing that we correctly register default values for 68 // extension options. 69 optional int32 field_opt2 = 7753913 [default=42]; 70} 71 72extend google.protobuf.EnumOptions { 73 optional sfixed32 enum_opt1 = 7753576; 74} 75 76extend google.protobuf.EnumValueOptions { 77 optional int32 enum_value_opt1 = 1560678; 78} 79 80extend google.protobuf.ServiceOptions { 81 optional sint64 service_opt1 = 7887650; 82} 83 84enum MethodOpt1 { 85 METHODOPT1_VAL1 = 1; 86 METHODOPT1_VAL2 = 2; 87} 88 89extend google.protobuf.MethodOptions { 90 optional MethodOpt1 method_opt1 = 7890860; 91} 92 93// A test message with custom options at all possible locations (and also some 94// regular options, to make sure they interact nicely). 95message TestMessageWithCustomOptions { 96 option message_set_wire_format = false; 97 98 option (message_opt1) = -56; 99 100 optional string field1 = 1 [ctype=CORD, 101 (field_opt1)=8765432109]; 102 103 enum AnEnum { 104 option (enum_opt1) = -789; 105 106 ANENUM_VAL1 = 1; 107 ANENUM_VAL2 = 2 [(enum_value_opt1) = 123]; 108 } 109} 110 111 112// A test RPC service with custom options at all possible locations (and also 113// some regular options, to make sure they interact nicely). 114message CustomOptionFooRequest { 115} 116 117message CustomOptionFooResponse { 118} 119 120message CustomOptionFooClientMessage { 121} 122 123message CustomOptionFooServerMessage { 124} 125 126service TestServiceWithCustomOptions { 127 option (service_opt1) = -9876543210; 128 129 rpc Foo(CustomOptionFooRequest) returns (CustomOptionFooResponse) { 130 option (method_opt1) = METHODOPT1_VAL2; 131 } 132} 133 134 135 136// Options of every possible field type, so we can test them all exhaustively. 137 138message DummyMessageContainingEnum { 139 enum TestEnumType { 140 TEST_OPTION_ENUM_TYPE1 = 22; 141 TEST_OPTION_ENUM_TYPE2 = -23; 142 } 143} 144 145message DummyMessageInvalidAsOptionType { 146} 147 148extend google.protobuf.MessageOptions { 149 optional bool bool_opt = 7706090; 150 optional int32 int32_opt = 7705709; 151 optional int64 int64_opt = 7705542; 152 optional uint32 uint32_opt = 7704880; 153 optional uint64 uint64_opt = 7702367; 154 optional sint32 sint32_opt = 7701568; 155 optional sint64 sint64_opt = 7700863; 156 optional fixed32 fixed32_opt = 7700307; 157 optional fixed64 fixed64_opt = 7700194; 158 optional sfixed32 sfixed32_opt = 7698645; 159 optional sfixed64 sfixed64_opt = 7685475; 160 optional float float_opt = 7675390; 161 optional double double_opt = 7673293; 162 optional string string_opt = 7673285; 163 optional bytes bytes_opt = 7673238; 164 optional DummyMessageContainingEnum.TestEnumType enum_opt = 7673233; 165 optional DummyMessageInvalidAsOptionType message_type_opt = 7665967; 166} 167 168message CustomOptionMinIntegerValues { 169 option (bool_opt) = false; 170 option (int32_opt) = -0x80000000; 171 option (int64_opt) = -0x8000000000000000; 172 option (uint32_opt) = 0; 173 option (uint64_opt) = 0; 174 option (sint32_opt) = -0x80000000; 175 option (sint64_opt) = -0x8000000000000000; 176 option (fixed32_opt) = 0; 177 option (fixed64_opt) = 0; 178 option (sfixed32_opt) = -0x80000000; 179 option (sfixed64_opt) = -0x8000000000000000; 180} 181 182message CustomOptionMaxIntegerValues { 183 option (bool_opt) = true; 184 option (int32_opt) = 0x7FFFFFFF; 185 option (int64_opt) = 0x7FFFFFFFFFFFFFFF; 186 option (uint32_opt) = 0xFFFFFFFF; 187 option (uint64_opt) = 0xFFFFFFFFFFFFFFFF; 188 option (sint32_opt) = 0x7FFFFFFF; 189 option (sint64_opt) = 0x7FFFFFFFFFFFFFFF; 190 option (fixed32_opt) = 0xFFFFFFFF; 191 option (fixed64_opt) = 0xFFFFFFFFFFFFFFFF; 192 option (sfixed32_opt) = 0x7FFFFFFF; 193 option (sfixed64_opt) = 0x7FFFFFFFFFFFFFFF; 194} 195 196message CustomOptionOtherValues { 197 option (int32_opt) = -100; // To test sign-extension. 198 option (float_opt) = 12.3456789; 199 option (double_opt) = 1.234567890123456789; 200 option (string_opt) = "Hello, \"World\""; 201 option (bytes_opt) = "Hello\0World"; 202 option (enum_opt) = TEST_OPTION_ENUM_TYPE2; 203} 204 205message SettingRealsFromPositiveInts { 206 option (float_opt) = 12; 207 option (double_opt) = 154; 208} 209 210message SettingRealsFromNegativeInts { 211 option (float_opt) = -12; 212 option (double_opt) = -154; 213} 214 215// Options of complex message types, themselves combined and extended in 216// various ways. 217 218message ComplexOptionType1 { 219 optional int32 foo = 1; 220 optional int32 foo2 = 2; 221 optional int32 foo3 = 3; 222 repeated int32 foo4 = 4; 223 224 extensions 100 to max; 225} 226 227message ComplexOptionType2 { 228 optional ComplexOptionType1 bar = 1; 229 optional int32 baz = 2; 230 231 message ComplexOptionType4 { 232 optional int32 waldo = 1; 233 234 extend google.protobuf.MessageOptions { 235 optional ComplexOptionType4 complex_opt4 = 7633546; 236 } 237 } 238 239 optional ComplexOptionType4 fred = 3; 240 repeated ComplexOptionType4 barney = 4; 241 242 extensions 100 to max; 243} 244 245message ComplexOptionType3 { 246 optional int32 qux = 1; 247 248 optional group ComplexOptionType5 = 2 { 249 optional int32 plugh = 3; 250 } 251} 252 253extend ComplexOptionType1 { 254 optional int32 quux = 7663707; 255 optional ComplexOptionType3 corge = 7663442; 256} 257 258extend ComplexOptionType2 { 259 optional int32 grault = 7650927; 260 optional ComplexOptionType1 garply = 7649992; 261} 262 263extend google.protobuf.MessageOptions { 264 optional protobuf_unittest.ComplexOptionType1 complex_opt1 = 7646756; 265 optional ComplexOptionType2 complex_opt2 = 7636949; 266 optional ComplexOptionType3 complex_opt3 = 7636463; 267 optional group ComplexOpt6 = 7595468 { 268 optional int32 xyzzy = 7593951; 269 } 270} 271 272// Note that we try various different ways of naming the same extension. 273message VariousComplexOptions { 274 option (.protobuf_unittest.complex_opt1).foo = 42; 275 option (protobuf_unittest.complex_opt1).(.protobuf_unittest.quux) = 324; 276 option (.protobuf_unittest.complex_opt1).(protobuf_unittest.corge).qux = 876; 277 option (protobuf_unittest.complex_opt1).foo4 = 99; 278 option (protobuf_unittest.complex_opt1).foo4 = 88; 279 option (complex_opt2).baz = 987; 280 option (complex_opt2).(grault) = 654; 281 option (complex_opt2).bar.foo = 743; 282 option (complex_opt2).bar.(quux) = 1999; 283 option (complex_opt2).bar.(protobuf_unittest.corge).qux = 2008; 284 option (complex_opt2).(garply).foo = 741; 285 option (complex_opt2).(garply).(.protobuf_unittest.quux) = 1998; 286 option (complex_opt2).(protobuf_unittest.garply).(corge).qux = 2121; 287 option (ComplexOptionType2.ComplexOptionType4.complex_opt4).waldo = 1971; 288 option (complex_opt2).fred.waldo = 321; 289 option (complex_opt2).barney = { waldo: 101 }; 290 option (complex_opt2).barney = { waldo: 212 }; 291 option (protobuf_unittest.complex_opt3).qux = 9; 292 option (complex_opt3).complexoptiontype5.plugh = 22; 293 option (complexopt6).xyzzy = 24; 294} 295 296// ------------------------------------------------------ 297// Definitions for testing aggregate option parsing. 298// See descriptor_unittest.cc. 299 300message AggregateMessageSet { 301 option message_set_wire_format = true; 302 extensions 4 to max; 303} 304 305message AggregateMessageSetElement { 306 extend AggregateMessageSet { 307 optional AggregateMessageSetElement message_set_extension = 15447542; 308 } 309 optional string s = 1; 310} 311 312// A helper type used to test aggregate option parsing 313message Aggregate { 314 optional int32 i = 1; 315 optional string s = 2; 316 317 // A nested object 318 optional Aggregate sub = 3; 319 320 // To test the parsing of extensions inside aggregate values 321 optional google.protobuf.FileOptions file = 4; 322 extend google.protobuf.FileOptions { 323 optional Aggregate nested = 15476903; 324 } 325 326 // An embedded message set 327 optional AggregateMessageSet mset = 5; 328} 329 330// Allow Aggregate to be used as an option at all possible locations 331// in the .proto grammer. 332extend google.protobuf.FileOptions { optional Aggregate fileopt = 15478479; } 333extend google.protobuf.MessageOptions { optional Aggregate msgopt = 15480088; } 334extend google.protobuf.FieldOptions { optional Aggregate fieldopt = 15481374; } 335extend google.protobuf.EnumOptions { optional Aggregate enumopt = 15483218; } 336extend google.protobuf.EnumValueOptions { optional Aggregate enumvalopt = 15486921; } 337extend google.protobuf.ServiceOptions { optional Aggregate serviceopt = 15497145; } 338extend google.protobuf.MethodOptions { optional Aggregate methodopt = 15512713; } 339 340// Try using AggregateOption at different points in the proto grammar 341option (fileopt) = { 342 s: 'FileAnnotation' 343 // Also test the handling of comments 344 /* of both types */ i: 100 345 346 sub { s: 'NestedFileAnnotation' } 347 348 // Include a google.protobuf.FileOptions and recursively extend it with 349 // another fileopt. 350 file { 351 [protobuf_unittest.fileopt] { 352 s:'FileExtensionAnnotation' 353 } 354 } 355 356 // A message set inside an option value 357 mset { 358 [protobuf_unittest.AggregateMessageSetElement.message_set_extension] { 359 s: 'EmbeddedMessageSetElement' 360 } 361 } 362}; 363 364message AggregateMessage { 365 option (msgopt) = { i:101 s:'MessageAnnotation' }; 366 optional int32 fieldname = 1 [(fieldopt) = { s:'FieldAnnotation' }]; 367} 368 369service AggregateService { 370 option (serviceopt) = { s:'ServiceAnnotation' }; 371 rpc Method (AggregateMessage) returns (AggregateMessage) { 372 option (methodopt) = { s:'MethodAnnotation' }; 373 } 374} 375 376enum AggregateEnum { 377 option (enumopt) = { s:'EnumAnnotation' }; 378 VALUE = 1 [(enumvalopt) = { s:'EnumValueAnnotation' }]; 379} 380 381// Test custom options for nested type. 382message NestedOptionType { 383 message NestedMessage { 384 option (message_opt1) = 1001; 385 optional int32 nested_field = 1 [(field_opt1) = 1002]; 386 } 387 enum NestedEnum { 388 option (enum_opt1) = 1003; 389 NESTED_ENUM_VALUE = 1 [(enum_value_opt1) = 1004]; 390 } 391 extend google.protobuf.FileOptions { 392 optional int32 nested_extension = 7912573 [(field_opt2) = 1005]; 393 } 394} 395 396// Custom message option that has a required enum field. 397// WARNING: this is strongly discouraged! 398message OldOptionType { 399 enum TestEnum { 400 OLD_VALUE = 0; 401 } 402 required TestEnum value = 1; 403} 404 405// Updated version of the custom option above. 406message NewOptionType { 407 enum TestEnum { 408 OLD_VALUE = 0; 409 NEW_VALUE = 1; 410 } 411 required TestEnum value = 1; 412} 413 414extend google.protobuf.MessageOptions { 415 optional OldOptionType required_enum_opt = 106161807; 416} 417 418// Test message using the "required_enum_opt" option defined above. 419message TestMessageWithRequiredEnumOption { 420 option (required_enum_opt) = { value: OLD_VALUE }; 421} 422