blob: 846d735e6cda4f9c0aac77f3412bf92f3913be9e [file] [log] [blame]
Bo Yang8908cf12015-05-26 14:37:47 -070012015-05-25 version 3.0.0-alpha-3 (Objective-C/C#):
2 General
3 * Introduced two new language implementations (Objective-C, C#) to proto3.
Bo Yang3e2c8a52015-05-28 14:52:44 -07004 * Explicit "optional" keyword are disallowed in proto3 syntax, as fields are
5 optional by default.
6 * Group fields are no longer supported in proto3 syntax.
Bo Yang8908cf12015-05-26 14:37:47 -07007 * Changed repeated primitive fields to use packed serialization by default in
8 proto3 (implemented for C++, Java, Python in this release). The user can
9 still disable packed serialization by setting packed to false for now.
10 * Added well-known type protos (any.proto, empty.proto, timestamp.proto,
11 duration.proto, etc.). Users can import and use these protos just like
12 regular proto files. Addtional runtime support will be added for them in
13 future releases (in the form of utility helper functions, or having them
14 replaced by language specific types in generated code).
15 * Added a "reserved" keyword in both proto2 and proto3 syntax. User can use
16 this keyword to declare reserved field numbers and names to prevent them
17 from being reused by other fields in the same message.
18
19 To reserve field numbers, add a reserved declaration in your message:
20
21 message TestMessage {
22 reserved 2, 15, 9 to 11, 3;
23 }
24
25 This reserves field numbers 2, 3, 9, 10, 11 and 15. If a user uses any of
26 these as field numbers, the protocol buffer compiler will report an error.
27
28 Field names can also be reserved:
29
30 message TestMessage {
31 reserved "foo", "bar";
32 }
33
34 * Various bug fixes since 3.0.0-alpha-2
35
36 Objective-C
37 Objective-C includes a code generator and a native objective-c runtime
38 library. By adding “--objc_out” to protoc, the code generator will generate
39 a header(*.pbobjc.h) and an implementation file(*.pbobjc.m) for each proto
40 file.
41
42 In this first release, the generated interface provides: enums, messages,
43 field support(single, repeated, map, oneof), proto2 and proto3 syntax
44 support, parsing and serialization. It’s compatible with ARC and non-ARC
45 usage. Besides, user can also access it via the swift bridging header.
46
47 See objectivec/README.md for details.
48
49 C#
50 * C# protobufs are based on project
51 https://github.com/jskeet/protobuf-csharp-port. The original project was
52 frozen and all the new development will happen here.
53 * Codegen plugin for C# was completely rewritten to C++ and is now an
54 intergral part of protoc.
55 * Some refactorings and cleanup has been applied to the C# runtime library.
56 * Only proto2 is supported in C# at the moment, proto3 support is in
57 progress and will likely bring significant breaking changes to the API.
58
59 See csharp/README.md for details.
60
61 C++
62 * Added runtime support for Any type. To use Any in your proto file, first
63 import the definition of Any:
64
65 // foo.proto
66 import "google/protobuf/any.proto";
67 message Foo {
68 google.protobuf.Any any_field = 1;
69 }
70 message Bar {
71 int32 value = 1;
72 }
73
74 Then in C++ you can access the Any field using PackFrom()/UnpackTo()
75 methods:
76
77 Foo foo;
78 Bar bar = ...;
79 foo.mutable_any_field()->PackFrom(bar);
80 ...
81 if (foo.any_field().IsType<Bar>()) {
82 foo.any_field().UnpackTo(&bar);
83 ...
84 }
85 * In text format, entries of a map field will be sorted by key.
86
87 Java
88 * Continued optimizations on the lite runtime to improve performance for
89 Android.
90
91 Python
92 * Added map support.
93 - maps now have a dict-like interface (msg.map_field[key] = value)
94 - existing code that modifies maps via the repeated field interface
95 will need to be updated.
96
97 Ruby
98 * Improvements to RepeatedField's emulation of the Ruby Array API.
99 * Various speedups and internal cleanups.
100
Josh Haberman7d5cf8d2015-02-25 23:47:09 -08001012015-02-26 version 3.0.0-alpha-2 (Python/Ruby/JavaNano):
Jisi Liu32f5d012015-02-20 14:45:45 -0800102 General
Josh Haberman7d5cf8d2015-02-25 23:47:09 -0800103 * Introduced three new language implementations (Ruby, JavaNano, and
104 Python) to proto3.
Jisi Liu32f5d012015-02-20 14:45:45 -0800105 * Various bug fixes since 3.0.0-alpha-1
106
Josh Haberman31e8c202015-02-25 23:06:35 -0800107 Python:
108 Python has received several updates, most notably support for proto3
109 semantics in any .proto file that declares syntax="proto3".
110 Messages declared in proto3 files no longer represent field presence
111 for scalar fields (number, enums, booleans, or strings). You can
112 no longer call HasField() for such fields, and they are serialized
113 based on whether they have a non-zero/empty/false value.
114
115 One other notable change is in the C++-accelerated implementation.
116 Descriptor objects (which describe the protobuf schema and allow
117 reflection over it) are no longer duplicated between the Python
118 and C++ layers. The Python descriptors are now simple wrappers
119 around the C++ descriptors. This change should significantly
120 reduce the memory usage of programs that use a lot of message
121 types.
122
Jisi Liu32f5d012015-02-20 14:45:45 -0800123 Ruby:
Chris Fallin1d4f3212015-02-20 17:32:06 -0800124 We have added proto3 support for Ruby via a native C extension.
125
126 The Ruby extension itself is included in the ruby/ directory, and details on
127 building and installing the extension are in ruby/README.md. The extension
128 will also be published as a Ruby gem. Code generator support is included as
129 part of `protoc` with the `--ruby_out` flag.
130
131 The Ruby extension implements a user-friendly DSL to define message types
132 (also generated by the code generator from `.proto` files). Once a message
133 type is defined, the user may create instances of the message that behave in
134 ways idiomatic to Ruby. For example:
135
136 - Message fields are present as ordinary Ruby properties (getter method
137 `foo` and setter method `foo=`).
138 - Repeated field elements are stored in a container that acts like a native
139 Ruby array, and map elements are stored in a container that acts like a
140 native Ruby hashmap.
141 - The usual well-known methods, such as `#to_s`, `#dup`, and the like, are
142 present.
143
144 Unlike several existing third-party Ruby extensions for protobuf, this
145 extension is built on a "strongly-typed" philosophy: message fields and
146 array/map containers will throw exceptions eagerly when values of the
147 incorrect type are inserted.
148
149 See ruby/README.md for details.
Jisi Liu32f5d012015-02-20 14:45:45 -0800150
151 JavaNano:
152 JavaNano is a special code generator and runtime library designed especially
153 for resource-restricted systems, like Android. It is very resource-friendly
154 in both the amount of code and the runtime overhead. Here is an an overview
155 of JavaNano features compared with the official Java protobuf:
156
157 - No descriptors or message builders.
158 - All messages are mutable; fields are public Java fields.
159 - For optional fields only, encapsulation behind setter/getter/hazzer/
160 clearer functions is opt-in, which provide proper 'has' state support.
161 - For proto2, if not opted in, has state (field presence) is not available.
162 Serialization outputs all fields not equal to their defaults.
163 The behavior is consistent with proto3 semantics.
164 - Required fields (proto2 only) are always serialized.
165 - Enum constants are integers; protection against invalid values only
166 when parsing from the wire.
167 - Enum constants can be generated into container interfaces bearing
168 the enum's name (so the referencing code is in Java style).
169 - CodedInputByteBufferNano can only take byte[] (not InputStream).
170 - Similarly CodedOutputByteBufferNano can only write to byte[].
171 - Repeated fields are in arrays, not ArrayList or Vector. Null array
172 elements are allowed and silently ignored.
173 - Full support for serializing/deserializing repeated packed fields.
174 - Support extensions (in proto2).
175 - Unset messages/groups are null, not an immutable empty default
176 instance.
177 - toByteArray(...) and mergeFrom(...) are now static functions of
178 MessageNano.
179 - The 'bytes' type translates to the Java type byte[].
180
181 See javanano/README.txt for details.
182
Feng Xiao9104da32014-12-09 11:57:52 -08001832014-12-01 version 3.0.0-alpha-1 (C++/Java):
184
185 General
186 * Introduced Protocol Buffers language version 3 (aka proto3).
187
188 When protobuf was initially opensourced it implemented Protocol Buffers
189 language version 2 (aka proto2), which is why the version number
190 started from v2.0.0. From v3.0.0, a new language version (proto3) is
191 introduced while the old version (proto2) will continue to be supported.
192
193 The main intent of introducing proto3 is to clean up protobuf before
194 pushing the language as the foundation of Google's new API platform.
195 In proto3, the language is simplified, both for ease of use and to
196 make it available in a wider range of programming languages. At the
197 same time a few features are added to better support common idioms
198 found in APIs.
199
200 The following are the main new features in language version 3:
201
202 1. Removal of field presence logic for primitive value fields, removal
203 of required fields, and removal of default values. This makes proto3
204 significantly easier to implement with open struct representations,
205 as in languages like Android Java, Objective C, or Go.
206 2. Removal of unknown fields.
207 3. Removal of extensions, which are instead replaced by a new standard
208 type called Any.
209 4. Fix semantics for unknown enum values.
210 5. Addition of maps.
211 6. Addition of a small set of standard types for representation of time,
212 dynamic data, etc.
213 7. A well-defined encoding in JSON as an alternative to binary proto
214 encoding.
215
216 This release (v3.0.0-alpha-1) includes partial proto3 support for C++ and
217 Java. Items 6 (well-known types) and 7 (JSON format) in the above feature
218 list are not impelmented.
219
220 A new notion "syntax" is introduced to specify whether a .proto file
221 uses proto2 or proto3:
222
223 // foo.proto
224 syntax = "proto3";
225 message Bar {...}
226
227 If omitted, the protocol compiler will generate a warning and "proto2" will
228 be used as the default. This warning will be turned into an error in a
229 future release.
230
231 We recommend that new Protocol Buffers users use proto3. However, we do not
232 generally recommend that existing users migrate from proto2 from proto3 due
233 to API incompatibility, and we will continue to support proto2 for a long
234 time.
235
236 * Added support for map fields (implemented in C++/Java for both proto2 and
237 proto3).
238
239 Map fields can be declared using the following syntax:
240
241 message Foo {
242 map<string, string> values = 1;
243 }
244
245 Data of a map field will be stored in memory as an unordered map and it
246 can be accessed through generated accessors.
247
248 C++
249 * Added arena allocation support (for both proto2 and proto3).
250
251 Profiling shows memory allocation and deallocation constitutes a significant
252 fraction of CPU-time spent in protobuf code and arena allocation is a
253 technique introduced to reduce this cost. With arena allocation, new
254 objects will be allocated from a large piece of preallocated memory and
255 deallocation of these objects is almost free. Early adoption shows 20% to
256 50% improvement in some Google binaries.
257
258 To enable arena support, add the following option to your .proto file:
259
260 option cc_enable_arenas = true;
261
262 Protocol compiler will generate additional code to make the generated
263 message classes work with arenas. This does not change the existing API
264 of protobuf messages and does not affect wire format. Your existing code
265 should continue to work after adding this option. In the future we will
266 make this option enabled by default.
267
268 To actually take advantage of arena allocation, you need to use the arena
269 APIs when creating messages. A quick example of using the arena API:
270
271 {
272 google::protobuf::Arena arena;
273 // Allocate a protobuf message in the arena.
274 MyMessage* message = Arena::CreateMessage<MyMessage>(&arena);
275 // All submessages will be allocated in the same arena.
276 if (!message->ParseFromString(data)) {
277 // Deal with malformed input data.
278 }
279 // Must not delete the message here. It will be deleted automatically
280 // when the arena is destroyed.
281 }
282
283 Currently arena does not work with map fields. Enabling arena in a .proto
284 file containing map fields will result in compile errors in the generated
285 code. This will be addressed in a future release.
286
Feng Xiaobba83652014-10-20 17:06:06 -07002872014-10-20 version 2.6.1:
Feng Xiao57b86722014-10-09 11:20:08 -0700288
289 C++
290 * Added atomicops support for Solaris.
291 * Released memory allocated by InitializeDefaultRepeatedFields() and
292 GetEmptyString(). Some memory sanitizers reported them as memory leaks.
293
294 Java
295 * Updated DynamicMessage.setField() to handle repeated enum values
296 correctly.
297 * Fixed a bug that caused NullPointerException to be thrown when
298 converting manually constructed FileDescriptorProto to
299 FileDescriptor.
300
301 Python
Feng Xiao419c94b2014-10-09 11:40:02 -0700302 * Fixed WhichOneof() to work with de-serialized protobuf messages.
Feng Xiao57b86722014-10-09 11:20:08 -0700303 * Fixed a missing file problem of Python C++ implementation.
304
jieluo@google.com1eba9d92014-08-25 20:17:53 +00003052014-08-15 version 2.6.0:
306
307 General
308 * Added oneofs(unions) feature. Fields in the same oneof will share
309 memory and at most one field can be set at the same time. Use the
310 oneof keyword to define a oneof like:
311 message SampleMessage {
312 oneof test_oneof {
313 string name = 4;
314 YourMessage sub_message = 9;
315 }
316 }
317 * Files, services, enums, messages, methods and enum values can be marked
318 as deprecated now.
319 * Added Support for list values, including lists of mesaages, when
320 parsing text-formatted protos in C++ and Java.
321 For example: foo: [1, 2, 3]
322
323 C++
324 * Enhanced customization on TestFormat printing.
325 * Added SwapFields() in reflection API to swap a subset of fields.
326 Added SetAllocatedMessage() in reflection API.
327 * Repeated primitive extensions are now packable. The
328 [packed=true] option only affects serializers. Therefore, it is
329 possible to switch a repeated extension field to packed format
330 without breaking backwards-compatibility.
331 * Various speed optimizations.
332
333 Java
334 * writeTo() method in ByteString can now write a substring to an
335 output stream. Added endWith() method for ByteString.
336 * ByteString and ByteBuffer are now supported in CodedInputStream
337 and CodedOutputStream.
338 * java_generate_equals_and_hash can now be used with the LITE_RUNTIME.
339
340 Python
341 * A new C++-backed extension module (aka "cpp api v2") that replaces the
342 old ("cpp api v1") one. Much faster than the pure Python code. This one
343 resolves many bugs and is recommended for general use over the
344 pure Python when possible.
345 * Descriptors now have enum_types_by_name and extension_types_by_name dict
346 attributes.
347 * Support for Python 3.
348
xiaofeng@google.com2c9392f2013-02-28 06:12:28 +00003492013-02-27 version 2.5.0:
xiaofeng@google.comb55a20f2012-09-22 02:40:50 +0000350
351 General
352 * New notion "import public" that allows a proto file to forward the content
353 it imports to its importers. For example,
354 // foo.proto
355 import public "bar.proto";
356 import "baz.proto";
357
358 // qux.proto
359 import "foo.proto";
360 // Stuff defined in bar.proto may be used in this file, but stuff from
361 // baz.proto may NOT be used without importing it explicitly.
362 This is useful for moving proto files. To move a proto file, just leave
363 a single "import public" in the old proto file.
364 * New enum option "allow_alias" that specifies whether different symbols can
365 be assigned the same numeric value. Default value is "true". Setting it to
366 false causes the compiler to reject enum definitions where multiple symbols
367 have the same numeric value.
xiaofeng@google.com7f4c9e82013-03-05 01:51:21 +0000368 Note: We plan to flip the default value to "false" in a future release.
369 Projects using enum aliases should set the option to "true" in their .proto
370 files.
xiaofeng@google.comb55a20f2012-09-22 02:40:50 +0000371
372 C++
373 * New generated method set_allocated_foo(Type* foo) for message and string
374 fields. This method allows you to set the field to a pre-allocated object
375 and the containing message takes the ownership of that object.
376 * Added SetAllocatedExtension() and ReleaseExtension() to extensions API.
377 * Custom options are now formatted correctly when descriptors are printed in
378 text format.
379 * Various speed optimizations.
380
381 Java
382 * Comments in proto files are now collected and put into generated code as
383 comments for corresponding classes and data members.
384 * Added Parser to parse directly into messages without a Builder. For
385 example,
xiaofeng@google.com2c9392f2013-02-28 06:12:28 +0000386 Foo foo = Foo.PARSER.ParseFrom(input);
xiaofeng@google.comb55a20f2012-09-22 02:40:50 +0000387 Using Parser is ~25% faster than using Builder to parse messages.
388 * Added getters/setters to access the underlying ByteString of a string field
389 directly.
390 * ByteString now supports more operations: substring(), prepend(), and
391 append(). The implementation of ByteString uses a binary tree structure
392 to support these operations efficiently.
393 * New method findInitializationErrors() that lists all missing required
394 fields.
395 * Various code size and speed optimizations.
396
397 Python
398 * Added support for dynamic message creation. DescriptorDatabase,
399 DescriptorPool, and MessageFactory work like their C++ couterparts to
400 simplify Descriptor construction from *DescriptorProtos, and MessageFactory
401 provides a message instance from a Descriptor.
402 * Added pickle support for protobuf messages.
403 * Unknown fields are now preserved after parsing.
404 * Fixed bug where custom options were not correctly populated. Custom
405 options can be accessed now.
406 * Added EnumTypeWrapper that provides better accessibility to enum types.
407 * Added ParseMessage(descriptor, bytes) to generate a new Message instance
408 from a descriptor and a byte string.
409
liujisi@google.com5d996322011-04-30 15:29:09 +00004102011-05-01 version 2.4.1:
411
412 C++
413 * Fixed the frendship problem for old compilers to make the library now gcc 3
414 compatible again.
415 * Fixed vcprojects/extract_includes.bat to extract compiler/plugin.h.
416
417 Java
418 * Removed usages of JDK 1.6 only features to make the library now JDK 1.5
419 compatible again.
420 * Fixed a bug about negative enum values.
421 * serialVersionUID is now defined in generated messages for java serializing.
422 * Fixed protoc to use java.lang.Object, which makes "Object" now a valid
423 message name again.
424
425 Python
426 * Experimental C++ implementation now requires C++ protobuf library installed.
427 See the README.txt in the python directory for details.
428
liujisi@google.com7a261472011-02-02 14:04:22 +00004292011-02-02 version 2.4.0:
liujisi@google.com33165fe2010-11-02 13:14:58 +0000430
431 General
432 * The RPC (cc|java|py)_generic_services default value is now false instead of
433 true.
434 * Custom options can have aggregate types. For example,
435 message MyOption {
436 optional string comment = 1;
437 optional string author = 2;
438 }
439 extend google.protobuf.FieldOptions {
440 optional MyOption myoption = 12345;
441 }
442 This option can now be set as follows:
443 message SomeType {
444 optional int32 field = 1 [(myoption) = { comment:'x' author:'y' }];
445 }
446
447 C++
448 * Various speed and code size optimizations.
449 * Added a release_foo() method on string and message fields.
450 * Fixed gzip_output_stream sub-stream handling.
451
452 Java
453 * Builders now maintain sub-builders for sub-messages. Use getFooBuilder() to
454 get the builder for the sub-message "foo". This allows you to repeatedly
455 modify deeply-nested sub-messages without rebuilding them.
456 * Builder.build() no longer invalidates the Builder for generated messages
457 (You may continue to modify it and then build another message).
458 * Code generator will generate efficient equals() and hashCode()
459 implementations if new option java_generate_equals_and_hash is enabled.
460 (Otherwise, reflection-based implementations are used.)
461 * Generated messages now implement Serializable.
462 * Fields with [deprecated=true] will be marked with @Deprecated in Java.
463 * Added lazy conversion of UTF-8 encoded strings to String objects to improve
464 performance.
465 * Various optimizations.
466 * Enum value can be accessed directly, instead of calling getNumber() on the
467 enum member.
468 * For each enum value, an integer constant is also generated with the suffix
469 _VALUE.
470
471 Python
472 * Added an experimental C++ implementation for Python messages via a Python
473 extension. Implementation type is controlled by an environment variable
474 PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION (valid values: "cpp" and "python")
475 The default value is currently "python" but will be changed to "cpp" in
476 future release.
477 * Improved performance on message instantiation significantly.
478 Most of the work on message instantiation is done just once per message
479 class, instead of once per message instance.
480 * Improved performance on text message parsing.
481 * Allow add() to forward keyword arguments to the concrete class.
482 E.g. instead of
483 item = repeated_field.add()
484 item.foo = bar
485 item.baz = quux
486 You can do:
487 repeated_field.add(foo=bar, baz=quux)
488 * Added a sort() interface to the BaseContainer.
489 * Added an extend() method to repeated composite fields.
490 * Added UTF8 debug string support.
491
temporald4e38c72010-01-09 07:35:50 +00004922010-01-08 version 2.3.0:
kenton@google.comfccb1462009-12-18 02:11:36 +0000493
494 General
495 * Parsers for repeated numeric fields now always accept both packed and
496 unpacked input. The [packed=true] option only affects serializers.
497 Therefore, it is possible to switch a field to packed format without
498 breaking backwards-compatibility -- as long as all parties are using
499 protobuf 2.3.0 or above, at least.
500 * The generic RPC service code generated by the C++, Java, and Python
501 generators can be disabled via file options:
502 option cc_generic_services = false;
503 option java_generic_services = false;
504 option py_generic_services = false;
505 This allows plugins to generate alternative code, possibly specific to some
506 particular RPC implementation.
507
508 protoc
509 * Now supports a plugin system for code generators. Plugins can generate
510 code for new languages or inject additional code into the output of other
511 code generators. Plugins are just binaries which accept a protocol buffer
512 on stdin and write a protocol buffer to stdout, so they may be written in
513 any language. See src/google/protobuf/compiler/plugin.proto.
kenton@google.com7f4938b2009-12-22 22:57:39 +0000514 **WARNING**: Plugins are experimental. The interface may change in a
515 future version.
kenton@google.com0225b352010-01-04 22:07:09 +0000516 * If the output location ends in .zip or .jar, protoc will write its output
517 to a zip/jar archive instead of a directory. For example:
518 protoc --java_out=myproto_srcs.jar --python_out=myproto.zip myproto.proto
519 Currently the archive contents are not compressed, though this could change
520 in the future.
kenton@google.comfccb1462009-12-18 02:11:36 +0000521 * inf, -inf, and nan can now be used as default values for float and double
522 fields.
523
524 C++
525 * Various speed and code size optimizations.
526 * DynamicMessageFactory is now fully thread-safe.
527 * Message::Utf8DebugString() method is like DebugString() but avoids escaping
528 UTF-8 bytes.
529 * Compiled-in message types can now contain dynamic extensions, through use
530 of CodedInputStream::SetExtensionRegistry().
kenton@google.comc0ee4d22009-12-22 02:05:33 +0000531 * Now compiles shared libraries (DLLs) by default on Cygwin and MinGW, to
532 match other platforms. Use --disable-shared to avoid this.
kenton@google.comfccb1462009-12-18 02:11:36 +0000533
534 Java
535 * parseDelimitedFrom() and mergeDelimitedFrom() now detect EOF and return
536 false/null instead of throwing an exception.
537 * Fixed some initialization ordering bugs.
538 * Fixes for OpenJDK 7.
539
540 Python
541 * 10-25 times faster than 2.2.0, still pure-Python.
542 * Calling a mutating method on a sub-message always instantiates the message
543 in its parent even if the mutating method doesn't actually mutate anything
544 (e.g. parsing from an empty string).
545 * Expanded descriptors a bit.
546
kenton@google.com201b9be2009-08-12 00:23:05 +00005472009-08-11 version 2.2.0:
kenton@google.comceb561d2009-06-25 19:05:36 +0000548
549 C++
kenton@google.com80b1d622009-07-29 01:13:20 +0000550 * Lite mode: The "optimize_for = LITE_RUNTIME" option causes the compiler
551 to generate code which only depends libprotobuf-lite, which is much smaller
552 than libprotobuf but lacks descriptors, reflection, and some other features.
kenton@google.comceb561d2009-06-25 19:05:36 +0000553 * Fixed bug where Message.Swap(Message) was only implemented for
554 optimize_for_speed. Swap now properly implemented in both modes
555 (Issue 91).
556 * Added RemoveLast and SwapElements(index1, index2) to Reflection
557 interface for repeated elements.
558 * Added Swap(Message) to Reflection interface.
kenton@google.comd2fd0632009-07-24 01:00:35 +0000559 * Floating-point literals in generated code that are intended to be
560 single-precision now explicitly have 'f' suffix to avoid pedantic warnings
561 produced by some compilers.
kenton@google.com80b1d622009-07-29 01:13:20 +0000562 * The [deprecated=true] option now causes the C++ code generator to generate
563 a GCC-style deprecation annotation (no-op on other compilers).
564 * google::protobuf::GetEnumDescriptor<SomeGeneratedEnumType>() returns the
565 EnumDescriptor for that type -- useful for templates which cannot call
566 SomeGeneratedEnumType_descriptor().
567 * Various optimizations and obscure bug fixes.
568
569 Java
570 * Lite mode: The "optimize_for = LITE_RUNTIME" option causes the compiler
571 to generate code which only depends libprotobuf-lite, which is much smaller
572 than libprotobuf but lacks descriptors, reflection, and some other features.
kenton@google.com80b1d622009-07-29 01:13:20 +0000573 * Lots of style cleanups.
574
575 Python
576 * Fixed endianness bug with floats and doubles.
577 * Text format parsing support.
578 * Fix bug with parsing packed repeated fields in embedded messages.
579 * Ability to initialize fields by passing keyword args to constructor.
580 * Support iterators in extend and __setslice__ for containers.
kenton@google.comceb561d2009-06-25 19:05:36 +0000581
kenton@google.com1fb3d392009-05-13 23:20:03 +00005822009-05-13 version 2.1.0:
kenton@google.com2d6daa72009-01-22 01:27:00 +0000583
584 General
585 * Repeated fields of primitive types (types other that string, group, and
586 nested messages) may now use the option [packed = true] to get a more
587 efficient encoding. In the new encoding, the entire list is written
588 as a single byte blob using the "length-delimited" wire type. Within
589 this blob, the individual values are encoded the same way they would
590 be normally except without a tag before each value (thus, they are
591 tightly "packed").
kenton@google.comcfa2d8a2009-04-18 00:02:12 +0000592 * For each field, the generated code contains an integer constant assigned
593 to the field number. For example, the .proto file:
594 message Foo { optional int bar_baz = 123; }
595 would generate the following constants, all with the integer value 123:
596 C++: Foo::kBarBazFieldNumber
597 Java: Foo.BAR_BAZ_FIELD_NUMBER
598 Python: Foo.BAR_BAZ_FIELD_NUMBER
599 Constants are also generated for extensions, with the same naming scheme.
600 These constants may be used as switch cases.
kenton@google.com37ad00d2009-04-21 21:00:39 +0000601 * Updated bundled Google Test to version 1.3.0. Google Test is now bundled
602 in its verbatim form as a nested autoconf package, so you can drop in any
603 other version of Google Test if needed.
kenton@google.comd37d46d2009-04-25 02:53:47 +0000604 * optimize_for = SPEED is now the default, by popular demand. Use
605 optimize_for = CODE_SIZE if code size is more important in your app.
606 * It is now an error to define a default value for a repeated field.
607 Previously, this was silently ignored (it had no effect on the generated
608 code).
609 * Fields can now be marked deprecated like:
610 optional int32 foo = 1 [deprecated = true];
611 Currently this does not have any actual effect, but in the future the code
612 generators may generate deprecation annotations in each language.
kenton@google.com9824eda2009-05-06 17:49:37 +0000613 * Cross-compiling should now be possible using the --with-protoc option to
614 configure. See README.txt for more info.
kenton@google.com2d6daa72009-01-22 01:27:00 +0000615
kenton@google.comf663b162009-04-15 19:50:54 +0000616 protoc
617 * --error_format=msvs option causes errors to be printed in Visual Studio
618 format, which should allow them to be clicked on in the build log to go
kenton@google.comd37d46d2009-04-25 02:53:47 +0000619 directly to the error location.
620 * The type name resolver will no longer resolve type names to fields. For
621 example, this now works:
622 message Foo {}
623 message Bar {
624 optional int32 Foo = 1;
625 optional Foo baz = 2;
626 }
627 Previously, the type of "baz" would resolve to "Bar.Foo", and you'd get
628 an error because Bar.Foo is a field, not a type. Now the type of "baz"
629 resolves to the message type Foo. This change is unlikely to make a
630 difference to anyone who follows the Protocol Buffers style guide.
kenton@google.comf663b162009-04-15 19:50:54 +0000631
kenton@google.com2d6daa72009-01-22 01:27:00 +0000632 C++
kenton@google.comd37d46d2009-04-25 02:53:47 +0000633 * Several optimizations, including but not limited to:
634 - Serialization, especially to flat arrays, is 10%-50% faster, possibly
635 more for small objects.
636 - Several descriptor operations which previously required locking no longer
637 do.
638 - Descriptors are now constructed lazily on first use, rather than at
639 process startup time. This should save memory in programs which do not
640 use descriptors or reflection.
641 - UnknownFieldSet completely redesigned to be more efficient (especially in
642 terms of memory usage).
643 - Various optimizations to reduce code size (though the serialization speed
644 optimizations increased code size).
kenton@google.com2d6daa72009-01-22 01:27:00 +0000645 * Message interface has method ParseFromBoundedZeroCopyStream() which parses
646 a limited number of bytes from an input stream rather than parsing until
647 EOF.
kenton@google.come59427a2009-04-16 22:30:56 +0000648 * GzipInputStream and GzipOutputStream support reading/writing gzip- or
649 zlib-compressed streams if zlib is available.
650 (google/protobuf/io/gzip_stream.h)
kenton@google.comd37d46d2009-04-25 02:53:47 +0000651 * DescriptorPool::FindAllExtensions() and corresponding
652 DescriptorDatabase::FindAllExtensions() can be used to enumerate all
653 extensions of a given type.
654 * For each enum type Foo, protoc will generate functions:
655 const string& Foo_Name(Foo value);
656 bool Foo_Parse(const string& name, Foo* result);
657 The former returns the name of the enum constant corresponding to the given
658 value while the latter finds the value corresponding to a name.
659 * RepeatedField and RepeatedPtrField now have back-insertion iterators.
660 * String fields now have setters that take a char* and a size, in addition
661 to the existing ones that took char* or const string&.
662 * DescriptorPool::AllowUnknownDependencies() may be used to tell
663 DescriptorPool to create placeholder descriptors for unknown entities
664 referenced in a FileDescriptorProto. This can allow you to parse a .proto
665 file without having access to other .proto files that it imports, for
666 example.
667 * Updated gtest to latest version. The gtest package is now included as a
668 nested autoconf package, so it should be able to drop new versions into the
669 "gtest" subdirectory without modification.
kenton@google.com2d6daa72009-01-22 01:27:00 +0000670
671 Java
672 * Fixed bug where Message.mergeFrom(Message) failed to merge extensions.
673 * Message interface has new method toBuilder() which is equivalent to
674 newBuilderForType().mergeFrom(this).
675 * All enums now implement the ProtocolMessageEnum interface.
676 * Setting a field to null now throws NullPointerException.
677 * Fixed tendency for TextFormat's parsing to overflow the stack when
678 parsing large string values. The underlying problem is with Java's
679 regex implementation (which unfortunately uses recursive backtracking
680 rather than building an NFA). Worked around by making use of possesive
681 quantifiers.
kenton@google.comd37d46d2009-04-25 02:53:47 +0000682 * Generated service classes now also generate pure interfaces. For a service
683 Foo, Foo.Interface is a pure interface containing all of the service's
684 defined methods. Foo.newReflectiveService() can be called to wrap an
685 instance of this interface in a class that implements the generic
686 RpcService interface, which provides reflection support that is usually
687 needed by RPC server implementations.
688 * RPC interfaces now support blocking operation in addition to non-blocking.
689 The protocol compiler generates separate blocking and non-blocking stubs
690 which operate against separate blocking and non-blocking RPC interfaces.
691 RPC implementations will have to implement the new interfaces in order to
692 support blocking mode.
693 * New I/O methods parseDelimitedFrom(), mergeDelimitedFrom(), and
694 writeDelimitedTo() read and write "delemited" messages from/to a stream,
695 meaning that the message size precedes the data. This way, you can write
696 multiple messages to a stream without having to worry about delimiting
697 them yourself.
698 * Throw a more descriptive exception when build() is double-called.
699 * Add a method to query whether CodedInputStream is at the end of the input
700 stream.
701 * Add a method to reset a CodedInputStream's size counter; useful when
702 reading many messages with the same stream.
703 * equals() and hashCode() now account for unknown fields.
pesho.petrov87e64e12008-12-24 01:07:22 +0000704
705 Python
706 * Added slicing support for repeated scalar fields. Added slice retrieval and
707 removal of repeated composite fields.
kenton@google.com2d6daa72009-01-22 01:27:00 +0000708 * Updated RPC interfaces to allow for blocking operation. A client may
709 now pass None for a callback when making an RPC, in which case the
710 call will block until the response is received, and the response
711 object will be returned directly to the caller. This interface change
712 cannot be used in practice until RPC implementations are updated to
713 implement it.
kenton@google.comd37d46d2009-04-25 02:53:47 +0000714 * Changes to input_stream.py should make protobuf compatible with appengine.
pesho.petrov87e64e12008-12-24 01:07:22 +0000715
kenton@google.com9f175282008-11-25 19:37:10 +00007162008-11-25 version 2.0.3:
717
718 protoc
719 * Enum values may now have custom options, using syntax similar to field
720 options.
721 * Fixed bug where .proto files which use custom options but don't actually
722 define them (i.e. they import another .proto file defining the options)
723 had to explicitly import descriptor.proto.
724 * Adjacent string literals in .proto files will now be concatenated, like in
725 C.
kenton@google.com2f669cb2008-12-02 05:59:15 +0000726 * If an input file is a Windows absolute path (e.g. "C:\foo\bar.proto") and
727 the import path only contains "." (or contains "." but does not contain
728 the file), protoc incorrectly thought that the file was under ".", because
729 it thought that the path was relative (since it didn't start with a slash).
730 This has been fixed.
kenton@google.com9f175282008-11-25 19:37:10 +0000731
732 C++
733 * Generated message classes now have a Swap() method which efficiently swaps
734 the contents of two objects.
735 * All message classes now have a SpaceUsed() method which returns an estimate
736 of the number of bytes of allocated memory currently owned by the object.
737 This is particularly useful when you are reusing a single message object
738 to improve performance but want to make sure it doesn't bloat up too large.
739 * New method Message::SerializeAsString() returns a string containing the
740 serialized data. May be more convenient than calling
741 SerializeToString(string*).
742 * In debug mode, log error messages when string-type fields are found to
743 contain bytes that are not valid UTF-8.
744 * Fixed bug where a message with multiple extension ranges couldn't parse
745 extensions.
746 * Fixed bug where MergeFrom(const Message&) didn't do anything if invoked on
747 a message that contained no fields (but possibly contained extensions).
748 * Fixed ShortDebugString() to not be O(n^2). Durr.
749 * Fixed crash in TextFormat parsing if the first token in the input caused a
750 tokenization error.
751 * Fixed obscure bugs in zero_copy_stream_impl.cc.
752 * Added support for HP C++ on Tru64.
753 * Only build tests on "make check", not "make".
754 * Fixed alignment issue that caused crashes when using DynamicMessage on
755 64-bit Sparc machines.
756 * Simplify template usage to work with MSVC 2003.
757 * Work around GCC 4.3.x x86_64 compiler bug that caused crashes on startup.
758 (This affected Fedora 9 in particular.)
kenton@google.com25bc5cd2008-12-04 20:34:50 +0000759 * Now works on "Solaris 10 using recent Sun Studio".
kenton@google.com9f175282008-11-25 19:37:10 +0000760
761 Java
762 * New overload of mergeFrom() which parses a slice of a byte array instead
763 of the whole thing.
764 * New method ByteString.asReadOnlyByteBuffer() does what it sounds like.
765 * Improved performance of isInitialized() when optimizing for code size.
766
767 Python
768 * Corrected ListFields() signature in Message base class to match what
769 subclasses actually implement.
770 * Some minor refactoring.
kenton@google.com2f669cb2008-12-02 05:59:15 +0000771 * Don't pass self as first argument to superclass constructor (no longer
772 allowed in Python 2.6).
kenton@google.com9f175282008-11-25 19:37:10 +0000773
kenton@google.com9b10f582008-09-30 00:09:40 +00007742008-09-29 version 2.0.2:
775
kenton@google.com24bf56f2008-09-24 20:31:01 +0000776 General
777 * License changed from Apache 2.0 to New BSD.
778 * It is now possible to define custom "options", which are basically
779 annotations which may be placed on definitions in a .proto file.
780 For example, you might define a field option called "foo" like so:
781 import "google/protobuf/descriptor.proto"
782 extend google.protobuf.FieldOptions {
783 optional string foo = 12345;
784 }
785 Then you annotate a field using the "foo" option:
786 message MyMessage {
787 optional int32 some_field = 1 [(foo) = "bar"]
788 }
789 The value of this option is then visible via the message's
790 Descriptor:
791 const FieldDescriptor* field =
792 MyMessage::descriptor()->FindFieldByName("some_field");
793 assert(field->options().GetExtension(foo) == "bar");
794 This feature has been implemented and tested in C++ and Java.
795 Other languages may or may not need to do extra work to support
796 custom options, depending on how they construct descriptors.
797
798 C++
799 * Fixed some GCC warnings that only occur when using -pedantic.
800 * Improved static initialization code, making ordering more
801 predictable among other things.
802 * TextFormat will no longer accept messages which contain multiple
803 instances of a singular field. Previously, the latter instance
kenton@google.com9b10f582008-09-30 00:09:40 +0000804 would overwrite the former.
kenton@google.com24bf56f2008-09-24 20:31:01 +0000805 * Now works on systems that don't have hash_map.
806
kenton@google.com9b10f582008-09-30 00:09:40 +0000807 Java
808 * Print @Override annotation in generated code where appropriate.
809
kenton@google.com24bf56f2008-09-24 20:31:01 +0000810 Python
811 * Strings now use the "unicode" type rather than the "str" type.
812 String fields may still be assigned ASCII "str" values; they will
813 automatically be converted.
814 * Adding a property to an object representing a repeated field now
815 raises an exception. For example:
816 # No longer works (and never should have).
817 message.some_repeated_field.foo = 1
kenton@google.com9b10f582008-09-30 00:09:40 +0000818
819 Windows
820 * We now build static libraries rather than DLLs by default on MSVC.
821 See vsprojects/readme.txt for more information.
822
temporala44f3c32008-08-15 18:32:02 +00008232008-08-15 version 2.0.1:
kenton@google.com9b10f582008-09-30 00:09:40 +0000824
825 protoc
826 * New flags --encode and --decode can be used to convert between protobuf text
827 format and binary format from the command-line.
828 * New flag --descriptor_set_out can be used to write FileDescriptorProtos for
829 all parsed files directly into a single output file. This is particularly
830 useful if you wish to parse .proto files from programs written in languages
831 other than C++: just run protoc as a background process and have it output
832 a FileDescriptorList, then parse that natively.
833 * Improved error message when an enum value's name conflicts with another
834 symbol defined in the enum type's scope, e.g. if two enum types declared
835 in the same scope have values with the same name. This is disallowed for
temporala44f3c32008-08-15 18:32:02 +0000836 compatibility with C++, but this wasn't clear from the error.
kenton@google.com9b10f582008-09-30 00:09:40 +0000837 * Fixed absolute output paths on Windows.
temporala44f3c32008-08-15 18:32:02 +0000838 * Allow trailing slashes in --proto_path mappings.
kenton@google.com9b10f582008-09-30 00:09:40 +0000839
840 C++
841 * Reflection objects are now per-class rather than per-instance. To make this
842 possible, the Reflection interface had to be changed such that all methods
843 take the Message instance as a parameter. This change improves performance
844 significantly in memory-bandwidth-limited use cases, since it makes the
845 message objects smaller. Note that source-incompatible interface changes
846 like this will not be made again after the library leaves beta.
temporala44f3c32008-08-15 18:32:02 +0000847 * Heuristically detect sub-messages when printing unknown fields.
kenton@google.com9b10f582008-09-30 00:09:40 +0000848 * Fix static initialization ordering bug that caused crashes at startup when
temporala44f3c32008-08-15 18:32:02 +0000849 compiling on Mac with static linking.
kenton@google.com9b10f582008-09-30 00:09:40 +0000850 * Fixed TokenizerTest when compiling with -DNDEBUG on Linux.
851 * Fixed incorrect definition of kint32min.
temporala44f3c32008-08-15 18:32:02 +0000852 * Fix bytes type setter to work with byte sequences with embedded NULLs.
853 * Other irrelevant tweaks.
854
kenton@google.com9b10f582008-09-30 00:09:40 +0000855 Java
856 * Fixed UnknownFieldSet's parsing of varints larger than 32 bits.
857 * Fixed TextFormat's parsing of "inf" and "nan".
858 * Fixed TextFormat's parsing of comments.
859 * Added info to Java POM that will be required when we upload the
temporala44f3c32008-08-15 18:32:02 +0000860 package to a Maven repo.
861
kenton@google.com9b10f582008-09-30 00:09:40 +0000862 Python
863 * MergeFrom(message) and CopyFrom(message) are now implemented.
864 * SerializeToString() raises an exception if the message is missing required
865 fields.
866 * Code organization improvements.
867 * Fixed doc comments for RpcController and RpcChannel, which had somehow been
temporala44f3c32008-08-15 18:32:02 +0000868 swapped.
kenton@google.com9b10f582008-09-30 00:09:40 +0000869 * Fixed text_format_test on Windows where floating-point exponents sometimes
870 contain extra zeros.
temporala44f3c32008-08-15 18:32:02 +0000871 * Fix Python service CallMethod() implementation.
872
873 Other
874 * Improved readmes.
875 * VIM syntax highlighting improvements.
876
temporal40ee5512008-07-10 02:12:20 +00008772008-07-07 version 2.0.0:
878
879 * First public release.