protobuf/js/message.js

1851 lines
60 KiB
JavaScript
Raw Normal View History

// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
/**
* @fileoverview Definition of jspb.Message.
*
* @author mwr@google.com (Mark Rawling)
*/
goog.provide('jspb.ExtensionFieldBinaryInfo');
goog.provide('jspb.ExtensionFieldInfo');
goog.provide('jspb.Message');
goog.require('goog.array');
goog.require('goog.asserts');
2016-03-30 18:39:59 +00:00
goog.require('goog.crypt.base64');
goog.require('jspb.BinaryReader');
goog.require('jspb.Map');
/**
* Stores information for a single extension field.
*
* For example, an extension field defined like so:
*
* extend BaseMessage {
* optional MyMessage my_field = 123;
* }
*
* will result in an ExtensionFieldInfo object with these properties:
*
* {
* fieldIndex: 123,
* fieldName: {my_field_renamed: 0},
* ctor: proto.example.MyMessage,
* toObjectFn: proto.example.MyMessage.toObject,
* isRepeated: 0
* }
*
* We include `toObjectFn` to allow the JSCompiler to perform dead-code removal
* on unused toObject() methods.
*
* If an extension field is primitive, ctor and toObjectFn will be null.
* isRepeated should be 0 or 1.
*
* binary{Reader,Writer}Fn and (if message type) binaryMessageSerializeFn are
* always provided. binaryReaderFn and binaryWriterFn are references to the
* appropriate methods on BinaryReader/BinaryWriter to read/write the value of
* this extension, and binaryMessageSerializeFn is a reference to the message
* class's .serializeBinary method, if available.
*
* @param {number} fieldNumber
* @param {Object} fieldName This has the extension field name as a property.
* @param {?function(new: jspb.Message, Array=)} ctor
* @param {?function((boolean|undefined),!jspb.Message):!Object} toObjectFn
* @param {number} isRepeated
* @constructor
* @struct
* @template T
*/
jspb.ExtensionFieldInfo = function(fieldNumber, fieldName, ctor, toObjectFn,
isRepeated) {
/** @const */
this.fieldIndex = fieldNumber;
/** @const */
this.fieldName = fieldName;
/** @const */
this.ctor = ctor;
/** @const */
this.toObjectFn = toObjectFn;
/** @const */
this.isRepeated = isRepeated;
};
/**
* Stores binary-related information for a single extension field.
* @param {!jspb.ExtensionFieldInfo<T>} fieldInfo
2017-03-29 21:32:48 +00:00
* @param {function(this:jspb.BinaryReader,number,?)} binaryReaderFn
* @param {function(this:jspb.BinaryWriter,number,?)
* |function(this:jspb.BinaryWriter,number,?,?,?,?,?)} binaryWriterFn
2016-09-19 20:45:07 +00:00
* @param {function(?,?)=} opt_binaryMessageSerializeFn
* @param {function(?,?)=} opt_binaryMessageDeserializeFn
* @param {boolean=} opt_isPacked
* @constructor
* @struct
* @template T
*/
jspb.ExtensionFieldBinaryInfo = function(fieldInfo, binaryReaderFn, binaryWriterFn,
2016-09-19 20:45:07 +00:00
opt_binaryMessageSerializeFn, opt_binaryMessageDeserializeFn, opt_isPacked) {
/** @const */
this.fieldInfo = fieldInfo;
/** @const */
this.binaryReaderFn = binaryReaderFn;
/** @const */
this.binaryWriterFn = binaryWriterFn;
/** @const */
2016-09-19 20:45:07 +00:00
this.binaryMessageSerializeFn = opt_binaryMessageSerializeFn;
/** @const */
2016-09-19 20:45:07 +00:00
this.binaryMessageDeserializeFn = opt_binaryMessageDeserializeFn;
/** @const */
2016-09-19 20:45:07 +00:00
this.isPacked = opt_isPacked;
};
2016-03-30 18:39:59 +00:00
/**
* @return {boolean} Does this field represent a sub Message?
*/
jspb.ExtensionFieldInfo.prototype.isMessageType = function() {
return !!this.ctor;
};
/**
* Base class for all JsPb messages.
2017-03-29 21:32:48 +00:00
*
* Several common methods (toObject, serializeBinary, in particular) are not
* defined on the prototype to encourage code patterns that minimize code bloat
* due to otherwise unused code on all protos contained in the project.
*
* If you want to call these methods on a generic message, either
* pass in your instance of method as a parameter:
* someFunction(instanceOfKnownProto,
* KnownProtoClass.prototype.serializeBinary);
* or use a lambda that knows the type:
* someFunction(()=>instanceOfKnownProto.serializeBinary());
* or, if you don't care about code size, just suppress the
* WARNING - Property serializeBinary never defined on jspb.Message
* and call it the intuitive way.
*
* @constructor
* @struct
*/
jspb.Message = function() {
};
/**
* @define {boolean} Whether to generate toObject methods for objects. Turn
* this off, if you do not want toObject to be ever used in your project.
* When turning off this flag, consider adding a conformance test that bans
* calling toObject. Enabling this will disable the JSCompiler's ability to
* dead code eliminate fields used in protocol buffers that are never used
* in an application.
*/
2019-04-09 13:23:32 +00:00
jspb.Message.GENERATE_TO_OBJECT =
goog.define('jspb.Message.GENERATE_TO_OBJECT', true);
/**
* @define {boolean} Whether to generate fromObject methods for objects. Turn
* this off, if you do not want fromObject to be ever used in your project.
* When turning off this flag, consider adding a conformance test that bans
* calling fromObject. Enabling this might disable the JSCompiler's ability
* to dead code eliminate fields used in protocol buffers that are never
* used in an application.
* By default this is enabled for test code only.
*/
2019-04-09 13:23:32 +00:00
jspb.Message.GENERATE_FROM_OBJECT = goog.define(
'jspb.Message.GENERATE_FROM_OBJECT', !goog.DISALLOW_TEST_ONLY_CODE);
Merge 3.2.x branch into master (#2648) * Down-integrate internal changes to github. * Update conformance test failure list. * Explicitly import used class in nano test to avoid random test fail. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * maps_test.js: check whether Symbol is defined before using it (#2524) Symbol is not yet available on older versions of Node.js and so this test fails with them. This change just directly checks whether Symbol is available before we try to use it. * Added well_known_types_embed.cc to CLEANFILES so that it gets cleaned up * Updated Makefile.am to fix out-of-tree builds * Added Bazel genrule for generating well_known_types_embed.cc In pull request #2517 I made this change for the CMake and autotools builds but forgot to do it for the Bazel build. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * Add new js file in extra dist. * Bump version number to 3.2.0 * Fixed issue with autoloading - Invalid paths (#2538) * PHP fix int64 decoding (#2516) * fix int64 decoding * fix int64 decoding + tests * Fix int64 decoding on 32-bit machines. * Fix warning in compiler/js/embed.cc embed.cc: In function ‘std::string CEscape(const string&)’: embed.cc:51:32: warning: comparison between signed and unsigned integer expressions [-Wsign-compare] for (int i = 0; i < str.size(); ++i) { ^ * Fix include in auto-generated well_known_types_embed.cc Restore include style fix (e3da722) that has been trampled by auto-generation of well_known_types_embed.cc * Fixed cross compilations with the Autotools build Pull request #2517 caused cross compilations to start failing, because the js_embed binary was being built to run on the target platform instead of on the build machine. This change updates the Autotools build to use the AX_PROG_CXX_FOR_BUILD macro to find a suitable compiler for the build machine and always use that when building js_embed. * Minor fix for autocreated object repeated fields and maps. - If setting/clearing a repeated field/map that was objects, check the class before checking the autocreator. - Just to be paranoid, don’t mutate within copy/mutableCopy for the autocreated classes to ensure there is less chance of issues if someone does something really crazy threading wise. - Some more tests for the internal AutocreatedArray/AutocreatedDictionary classes to ensure things are working as expected. - Add Xcode 8.2 to the full_mac_build.sh supported list. * Fix generation of extending nested messages in JavaScript (#2439) * Fix generation of extending nested messages in JavaScript * Added missing test8.proto to build * Fix generated code when there is no namespace but there is enum definition. * Decoding unknown field should succeed. * Add embed.cc in src/Makefile.am to fix dist check. * Fixed "make distcheck" for the Autotools build To make the test pass I needed to fix out-of-tree builds and update EXTRA_DIST and CLEANFILES. * Remove redundent embed.cc from src/Makefile.am * Update version number to 3.2.0-rc.1 (#2578) * Change protoc-artifacts version to 3.2.0-rc.1 * Update version number to 3.2.0rc2 * Update change logs for 3.2.0 release. * Update php README * Update upb, fixes some bugs (including a hash table problem). (#2611) * Update upb, fixes some bugs (including a hash table problem). * Ruby: added a test for the previous hash table corruption. Verified that this triggers the bug in the currently released version. * Ruby: bugfix for SEGV. * Ruby: removed old code for dup'ing defs. * Reverting deployment target to 7.0 (#2618) The Protobuf library doesn’t require the 7.1 deployment target so reverting it back to 7.0 * Fix typo that breaks builds on big-endian (#2632) * Bump version number to 3.2.0
2017-01-31 17:17:32 +00:00
/**
* @define {boolean} Whether to generate toString methods for objects. Turn
* this off if you do not use toString in your project and want to trim it
* from the compiled JS.
Merge 3.2.x branch into master (#2648) * Down-integrate internal changes to github. * Update conformance test failure list. * Explicitly import used class in nano test to avoid random test fail. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * maps_test.js: check whether Symbol is defined before using it (#2524) Symbol is not yet available on older versions of Node.js and so this test fails with them. This change just directly checks whether Symbol is available before we try to use it. * Added well_known_types_embed.cc to CLEANFILES so that it gets cleaned up * Updated Makefile.am to fix out-of-tree builds * Added Bazel genrule for generating well_known_types_embed.cc In pull request #2517 I made this change for the CMake and autotools builds but forgot to do it for the Bazel build. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * Add new js file in extra dist. * Bump version number to 3.2.0 * Fixed issue with autoloading - Invalid paths (#2538) * PHP fix int64 decoding (#2516) * fix int64 decoding * fix int64 decoding + tests * Fix int64 decoding on 32-bit machines. * Fix warning in compiler/js/embed.cc embed.cc: In function ‘std::string CEscape(const string&)’: embed.cc:51:32: warning: comparison between signed and unsigned integer expressions [-Wsign-compare] for (int i = 0; i < str.size(); ++i) { ^ * Fix include in auto-generated well_known_types_embed.cc Restore include style fix (e3da722) that has been trampled by auto-generation of well_known_types_embed.cc * Fixed cross compilations with the Autotools build Pull request #2517 caused cross compilations to start failing, because the js_embed binary was being built to run on the target platform instead of on the build machine. This change updates the Autotools build to use the AX_PROG_CXX_FOR_BUILD macro to find a suitable compiler for the build machine and always use that when building js_embed. * Minor fix for autocreated object repeated fields and maps. - If setting/clearing a repeated field/map that was objects, check the class before checking the autocreator. - Just to be paranoid, don’t mutate within copy/mutableCopy for the autocreated classes to ensure there is less chance of issues if someone does something really crazy threading wise. - Some more tests for the internal AutocreatedArray/AutocreatedDictionary classes to ensure things are working as expected. - Add Xcode 8.2 to the full_mac_build.sh supported list. * Fix generation of extending nested messages in JavaScript (#2439) * Fix generation of extending nested messages in JavaScript * Added missing test8.proto to build * Fix generated code when there is no namespace but there is enum definition. * Decoding unknown field should succeed. * Add embed.cc in src/Makefile.am to fix dist check. * Fixed "make distcheck" for the Autotools build To make the test pass I needed to fix out-of-tree builds and update EXTRA_DIST and CLEANFILES. * Remove redundent embed.cc from src/Makefile.am * Update version number to 3.2.0-rc.1 (#2578) * Change protoc-artifacts version to 3.2.0-rc.1 * Update version number to 3.2.0rc2 * Update change logs for 3.2.0 release. * Update php README * Update upb, fixes some bugs (including a hash table problem). (#2611) * Update upb, fixes some bugs (including a hash table problem). * Ruby: added a test for the previous hash table corruption. Verified that this triggers the bug in the currently released version. * Ruby: bugfix for SEGV. * Ruby: removed old code for dup'ing defs. * Reverting deployment target to 7.0 (#2618) The Protobuf library doesn’t require the 7.1 deployment target so reverting it back to 7.0 * Fix typo that breaks builds on big-endian (#2632) * Bump version number to 3.2.0
2017-01-31 17:17:32 +00:00
*/
2019-04-09 13:23:32 +00:00
jspb.Message.GENERATE_TO_STRING =
goog.define('jspb.Message.GENERATE_TO_STRING', true);
Merge 3.2.x branch into master (#2648) * Down-integrate internal changes to github. * Update conformance test failure list. * Explicitly import used class in nano test to avoid random test fail. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * maps_test.js: check whether Symbol is defined before using it (#2524) Symbol is not yet available on older versions of Node.js and so this test fails with them. This change just directly checks whether Symbol is available before we try to use it. * Added well_known_types_embed.cc to CLEANFILES so that it gets cleaned up * Updated Makefile.am to fix out-of-tree builds * Added Bazel genrule for generating well_known_types_embed.cc In pull request #2517 I made this change for the CMake and autotools builds but forgot to do it for the Bazel build. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * Add new js file in extra dist. * Bump version number to 3.2.0 * Fixed issue with autoloading - Invalid paths (#2538) * PHP fix int64 decoding (#2516) * fix int64 decoding * fix int64 decoding + tests * Fix int64 decoding on 32-bit machines. * Fix warning in compiler/js/embed.cc embed.cc: In function ‘std::string CEscape(const string&)’: embed.cc:51:32: warning: comparison between signed and unsigned integer expressions [-Wsign-compare] for (int i = 0; i < str.size(); ++i) { ^ * Fix include in auto-generated well_known_types_embed.cc Restore include style fix (e3da722) that has been trampled by auto-generation of well_known_types_embed.cc * Fixed cross compilations with the Autotools build Pull request #2517 caused cross compilations to start failing, because the js_embed binary was being built to run on the target platform instead of on the build machine. This change updates the Autotools build to use the AX_PROG_CXX_FOR_BUILD macro to find a suitable compiler for the build machine and always use that when building js_embed. * Minor fix for autocreated object repeated fields and maps. - If setting/clearing a repeated field/map that was objects, check the class before checking the autocreator. - Just to be paranoid, don’t mutate within copy/mutableCopy for the autocreated classes to ensure there is less chance of issues if someone does something really crazy threading wise. - Some more tests for the internal AutocreatedArray/AutocreatedDictionary classes to ensure things are working as expected. - Add Xcode 8.2 to the full_mac_build.sh supported list. * Fix generation of extending nested messages in JavaScript (#2439) * Fix generation of extending nested messages in JavaScript * Added missing test8.proto to build * Fix generated code when there is no namespace but there is enum definition. * Decoding unknown field should succeed. * Add embed.cc in src/Makefile.am to fix dist check. * Fixed "make distcheck" for the Autotools build To make the test pass I needed to fix out-of-tree builds and update EXTRA_DIST and CLEANFILES. * Remove redundent embed.cc from src/Makefile.am * Update version number to 3.2.0-rc.1 (#2578) * Change protoc-artifacts version to 3.2.0-rc.1 * Update version number to 3.2.0rc2 * Update change logs for 3.2.0 release. * Update php README * Update upb, fixes some bugs (including a hash table problem). (#2611) * Update upb, fixes some bugs (including a hash table problem). * Ruby: added a test for the previous hash table corruption. Verified that this triggers the bug in the currently released version. * Ruby: bugfix for SEGV. * Ruby: removed old code for dup'ing defs. * Reverting deployment target to 7.0 (#2618) The Protobuf library doesn’t require the 7.1 deployment target so reverting it back to 7.0 * Fix typo that breaks builds on big-endian (#2632) * Bump version number to 3.2.0
2017-01-31 17:17:32 +00:00
/**
* @define {boolean} Whether arrays passed to initialize() can be assumed to be
* local (e.g. not from another iframe) and thus safely classified with
* instanceof Array.
*/
2019-04-09 13:23:32 +00:00
jspb.Message.ASSUME_LOCAL_ARRAYS =
goog.define('jspb.Message.ASSUME_LOCAL_ARRAYS', false);
Merge 3.2.x branch into master (#2648) * Down-integrate internal changes to github. * Update conformance test failure list. * Explicitly import used class in nano test to avoid random test fail. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * maps_test.js: check whether Symbol is defined before using it (#2524) Symbol is not yet available on older versions of Node.js and so this test fails with them. This change just directly checks whether Symbol is available before we try to use it. * Added well_known_types_embed.cc to CLEANFILES so that it gets cleaned up * Updated Makefile.am to fix out-of-tree builds * Added Bazel genrule for generating well_known_types_embed.cc In pull request #2517 I made this change for the CMake and autotools builds but forgot to do it for the Bazel build. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * Add new js file in extra dist. * Bump version number to 3.2.0 * Fixed issue with autoloading - Invalid paths (#2538) * PHP fix int64 decoding (#2516) * fix int64 decoding * fix int64 decoding + tests * Fix int64 decoding on 32-bit machines. * Fix warning in compiler/js/embed.cc embed.cc: In function ‘std::string CEscape(const string&)’: embed.cc:51:32: warning: comparison between signed and unsigned integer expressions [-Wsign-compare] for (int i = 0; i < str.size(); ++i) { ^ * Fix include in auto-generated well_known_types_embed.cc Restore include style fix (e3da722) that has been trampled by auto-generation of well_known_types_embed.cc * Fixed cross compilations with the Autotools build Pull request #2517 caused cross compilations to start failing, because the js_embed binary was being built to run on the target platform instead of on the build machine. This change updates the Autotools build to use the AX_PROG_CXX_FOR_BUILD macro to find a suitable compiler for the build machine and always use that when building js_embed. * Minor fix for autocreated object repeated fields and maps. - If setting/clearing a repeated field/map that was objects, check the class before checking the autocreator. - Just to be paranoid, don’t mutate within copy/mutableCopy for the autocreated classes to ensure there is less chance of issues if someone does something really crazy threading wise. - Some more tests for the internal AutocreatedArray/AutocreatedDictionary classes to ensure things are working as expected. - Add Xcode 8.2 to the full_mac_build.sh supported list. * Fix generation of extending nested messages in JavaScript (#2439) * Fix generation of extending nested messages in JavaScript * Added missing test8.proto to build * Fix generated code when there is no namespace but there is enum definition. * Decoding unknown field should succeed. * Add embed.cc in src/Makefile.am to fix dist check. * Fixed "make distcheck" for the Autotools build To make the test pass I needed to fix out-of-tree builds and update EXTRA_DIST and CLEANFILES. * Remove redundent embed.cc from src/Makefile.am * Update version number to 3.2.0-rc.1 (#2578) * Change protoc-artifacts version to 3.2.0-rc.1 * Update version number to 3.2.0rc2 * Update change logs for 3.2.0 release. * Update php README * Update upb, fixes some bugs (including a hash table problem). (#2611) * Update upb, fixes some bugs (including a hash table problem). * Ruby: added a test for the previous hash table corruption. Verified that this triggers the bug in the currently released version. * Ruby: bugfix for SEGV. * Ruby: removed old code for dup'ing defs. * Reverting deployment target to 7.0 (#2618) The Protobuf library doesn’t require the 7.1 deployment target so reverting it back to 7.0 * Fix typo that breaks builds on big-endian (#2632) * Bump version number to 3.2.0
2017-01-31 17:17:32 +00:00
// TODO(jakubvrana): Turn this off by default.
/**
* @define {boolean} Disabling the serialization of empty trailing fields
* reduces the size of serialized protos. The price is an extra iteration of
* the proto before serialization. This is enabled by default to be
* backwards compatible. Projects are advised to turn this flag always off.
*/
2019-04-09 13:23:32 +00:00
jspb.Message.SERIALIZE_EMPTY_TRAILING_FIELDS =
goog.define('jspb.Message.SERIALIZE_EMPTY_TRAILING_FIELDS', true);
2016-03-30 18:39:59 +00:00
/**
* Does this JavaScript environment support Uint8Aray typed arrays?
2016-03-30 18:39:59 +00:00
* @type {boolean}
* @private
*/
jspb.Message.SUPPORTS_UINT8ARRAY_ = (typeof Uint8Array == 'function');
/**
* The internal data array.
* @type {!Array}
* @protected
*/
jspb.Message.prototype.array;
/**
* Wrappers are the constructed instances of message-type fields. They are built
* on demand from the raw array data. Includes message fields, repeated message
* fields and extension message fields. Indexed by field number.
* @type {Object}
* @private
*/
jspb.Message.prototype.wrappers_;
/**
* The object that contains extension fields, if any. This is an object that
* maps from a proto field number to the field's value.
* @type {Object}
* @private
*/
jspb.Message.prototype.extensionObject_;
/**
* Non-extension fields with a field number at or above the pivot are
* stored in the extension object (in addition to all extension fields).
* @type {number}
* @private
*/
jspb.Message.prototype.pivot_;
/**
* The JsPb message_id of this proto.
* @type {string|undefined} the message id or undefined if this message
* has no id.
* @private
*/
jspb.Message.prototype.messageId_;
2016-03-30 18:39:59 +00:00
/**
* Repeated fields that have been converted to their proper type. This is used
* for numbers stored as strings (typically "NaN", "Infinity" and "-Infinity")
* and for booleans stored as numbers (0 or 1).
2016-03-30 18:39:59 +00:00
* @private {!Object<number,boolean>|undefined}
*/
jspb.Message.prototype.convertedPrimitiveFields_;
2016-03-30 18:39:59 +00:00
/**
* Repeated fields numbers.
* @protected {?Array<number>|undefined}
*/
jspb.Message.prototype.repeatedFields;
/**
* Returns the JsPb message_id of this proto.
* @return {string|undefined} the message id or undefined if this message
* has no id.
*/
jspb.Message.prototype.getJsPbMessageId = function() {
return this.messageId_;
};
/**
* An offset applied to lookups into this.array to account for the presence or
* absence of a messageId at position 0. For response messages, this will be 0.
* Otherwise, it will be -1 so that the first array position is not wasted.
* @type {number}
* @private
*/
jspb.Message.prototype.arrayIndexOffset_;
/**
* Returns the index into msg.array at which the proto field with tag number
* fieldNumber will be located.
* @param {!jspb.Message} msg Message for which we're calculating an index.
* @param {number} fieldNumber The field number.
* @return {number} The index.
* @private
*/
jspb.Message.getIndex_ = function(msg, fieldNumber) {
return fieldNumber + msg.arrayIndexOffset_;
};
2019-04-09 13:23:32 +00:00
// This is only here to ensure we are not back sliding on ES6 requiements for
// protos in g3.
jspb.Message.hiddenES6Property_ = class {};
/**
* Returns the tag number based on the index in msg.array.
* @param {!jspb.Message} msg Message for which we're calculating an index.
* @param {number} index The tag number.
* @return {number} The field number.
* @private
*/
jspb.Message.getFieldNumber_ = function(msg, index) {
return index - msg.arrayIndexOffset_;
};
/**
* Initializes a JsPb Message.
* @param {!jspb.Message} msg The JsPb proto to modify.
* @param {Array|undefined} data An initial data array.
* @param {string|number} messageId For response messages, the message id or ''
* if no message id is specified. For non-response messages, 0.
* @param {number} suggestedPivot The field number at which to start putting
* fields into the extension object. This is only used if data does not
* contain an extension object already. -1 if no extension object is
* required for this message type.
* @param {Array<number>} repeatedFields The message's repeated fields.
* @param {Array<!Array<number>>=} opt_oneofFields The fields belonging to
* each of the message's oneof unions.
* @protected
*/
jspb.Message.initialize = function(
msg, data, messageId, suggestedPivot, repeatedFields, opt_oneofFields) {
msg.wrappers_ = null;
if (!data) {
data = messageId ? [messageId] : [];
}
msg.messageId_ = messageId ? String(messageId) : undefined;
// If the messageId is 0, this message is not a response message, so we shift
// array indices down by 1 so as not to waste the first position in the array,
// which would otherwise go unused.
msg.arrayIndexOffset_ = messageId === 0 ? -1 : 0;
msg.array = data;
jspb.Message.initPivotAndExtensionObject_(msg, suggestedPivot);
msg.convertedPrimitiveFields_ = {};
2016-03-30 18:39:59 +00:00
if (!jspb.Message.SERIALIZE_EMPTY_TRAILING_FIELDS) {
// TODO(jakubvrana): This is same for all instances, move to prototype.
// TODO(jakubvrana): There are indexOf calls on this in serializtion,
// consider switching to a set.
msg.repeatedFields = repeatedFields;
}
if (repeatedFields) {
for (var i = 0; i < repeatedFields.length; i++) {
var fieldNumber = repeatedFields[i];
if (fieldNumber < msg.pivot_) {
var index = jspb.Message.getIndex_(msg, fieldNumber);
msg.array[index] =
msg.array[index] || jspb.Message.EMPTY_LIST_SENTINEL_;
} else {
jspb.Message.maybeInitEmptyExtensionObject_(msg);
msg.extensionObject_[fieldNumber] = msg.extensionObject_[fieldNumber] ||
jspb.Message.EMPTY_LIST_SENTINEL_;
}
}
}
if (opt_oneofFields && opt_oneofFields.length) {
// Compute the oneof case for each union. This ensures only one value is
// set in the union.
for (var i = 0; i < opt_oneofFields.length; i++) {
jspb.Message.computeOneofCase(msg, opt_oneofFields[i]);
}
}
};
/**
* Used to mark empty repeated fields. Serializes to null when serialized
* to JSON.
* When reading a repeated field readers must check the return value against
* this value and return and replace it with a new empty array if it is
* present.
* @private @const {!Object}
*/
jspb.Message.EMPTY_LIST_SENTINEL_ = goog.DEBUG && Object.freeze ?
Object.freeze([]) :
[];
Merge 3.2.x branch into master (#2648) * Down-integrate internal changes to github. * Update conformance test failure list. * Explicitly import used class in nano test to avoid random test fail. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * maps_test.js: check whether Symbol is defined before using it (#2524) Symbol is not yet available on older versions of Node.js and so this test fails with them. This change just directly checks whether Symbol is available before we try to use it. * Added well_known_types_embed.cc to CLEANFILES so that it gets cleaned up * Updated Makefile.am to fix out-of-tree builds * Added Bazel genrule for generating well_known_types_embed.cc In pull request #2517 I made this change for the CMake and autotools builds but forgot to do it for the Bazel build. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * Add new js file in extra dist. * Bump version number to 3.2.0 * Fixed issue with autoloading - Invalid paths (#2538) * PHP fix int64 decoding (#2516) * fix int64 decoding * fix int64 decoding + tests * Fix int64 decoding on 32-bit machines. * Fix warning in compiler/js/embed.cc embed.cc: In function ‘std::string CEscape(const string&)’: embed.cc:51:32: warning: comparison between signed and unsigned integer expressions [-Wsign-compare] for (int i = 0; i < str.size(); ++i) { ^ * Fix include in auto-generated well_known_types_embed.cc Restore include style fix (e3da722) that has been trampled by auto-generation of well_known_types_embed.cc * Fixed cross compilations with the Autotools build Pull request #2517 caused cross compilations to start failing, because the js_embed binary was being built to run on the target platform instead of on the build machine. This change updates the Autotools build to use the AX_PROG_CXX_FOR_BUILD macro to find a suitable compiler for the build machine and always use that when building js_embed. * Minor fix for autocreated object repeated fields and maps. - If setting/clearing a repeated field/map that was objects, check the class before checking the autocreator. - Just to be paranoid, don’t mutate within copy/mutableCopy for the autocreated classes to ensure there is less chance of issues if someone does something really crazy threading wise. - Some more tests for the internal AutocreatedArray/AutocreatedDictionary classes to ensure things are working as expected. - Add Xcode 8.2 to the full_mac_build.sh supported list. * Fix generation of extending nested messages in JavaScript (#2439) * Fix generation of extending nested messages in JavaScript * Added missing test8.proto to build * Fix generated code when there is no namespace but there is enum definition. * Decoding unknown field should succeed. * Add embed.cc in src/Makefile.am to fix dist check. * Fixed "make distcheck" for the Autotools build To make the test pass I needed to fix out-of-tree builds and update EXTRA_DIST and CLEANFILES. * Remove redundent embed.cc from src/Makefile.am * Update version number to 3.2.0-rc.1 (#2578) * Change protoc-artifacts version to 3.2.0-rc.1 * Update version number to 3.2.0rc2 * Update change logs for 3.2.0 release. * Update php README * Update upb, fixes some bugs (including a hash table problem). (#2611) * Update upb, fixes some bugs (including a hash table problem). * Ruby: added a test for the previous hash table corruption. Verified that this triggers the bug in the currently released version. * Ruby: bugfix for SEGV. * Ruby: removed old code for dup'ing defs. * Reverting deployment target to 7.0 (#2618) The Protobuf library doesn’t require the 7.1 deployment target so reverting it back to 7.0 * Fix typo that breaks builds on big-endian (#2632) * Bump version number to 3.2.0
2017-01-31 17:17:32 +00:00
/**
* Returns true if the provided argument is an array.
* @param {*} o The object to classify as array or not.
* @return {boolean} True if the provided object is an array.
* @private
*/
jspb.Message.isArray_ = function(o) {
return jspb.Message.ASSUME_LOCAL_ARRAYS ? o instanceof Array :
goog.isArray(o);
};
/**
* Returns true if the provided argument is an extension object.
* @param {*} o The object to classify as array or not.
* @return {boolean} True if the provided object is an extension object.
* @private
*/
jspb.Message.isExtensionObject_ = function(o) {
// Normal fields are never objects, so we can be sure that if we find an
// object here, then it's the extension object. However, we must ensure that
// the object is not an array, since arrays are valid field values (bytes
// fields can also be array).
// NOTE(lukestebbing): We avoid looking at .length to avoid a JIT bug
// in Safari on iOS 8. See the description of CL/86511464 for details.
return (o !== null && typeof o == 'object' &&
!jspb.Message.isArray_(o) &&
!(jspb.Message.SUPPORTS_UINT8ARRAY_ && o instanceof Uint8Array));
};
Merge 3.2.x branch into master (#2648) * Down-integrate internal changes to github. * Update conformance test failure list. * Explicitly import used class in nano test to avoid random test fail. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * maps_test.js: check whether Symbol is defined before using it (#2524) Symbol is not yet available on older versions of Node.js and so this test fails with them. This change just directly checks whether Symbol is available before we try to use it. * Added well_known_types_embed.cc to CLEANFILES so that it gets cleaned up * Updated Makefile.am to fix out-of-tree builds * Added Bazel genrule for generating well_known_types_embed.cc In pull request #2517 I made this change for the CMake and autotools builds but forgot to do it for the Bazel build. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * Add new js file in extra dist. * Bump version number to 3.2.0 * Fixed issue with autoloading - Invalid paths (#2538) * PHP fix int64 decoding (#2516) * fix int64 decoding * fix int64 decoding + tests * Fix int64 decoding on 32-bit machines. * Fix warning in compiler/js/embed.cc embed.cc: In function ‘std::string CEscape(const string&)’: embed.cc:51:32: warning: comparison between signed and unsigned integer expressions [-Wsign-compare] for (int i = 0; i < str.size(); ++i) { ^ * Fix include in auto-generated well_known_types_embed.cc Restore include style fix (e3da722) that has been trampled by auto-generation of well_known_types_embed.cc * Fixed cross compilations with the Autotools build Pull request #2517 caused cross compilations to start failing, because the js_embed binary was being built to run on the target platform instead of on the build machine. This change updates the Autotools build to use the AX_PROG_CXX_FOR_BUILD macro to find a suitable compiler for the build machine and always use that when building js_embed. * Minor fix for autocreated object repeated fields and maps. - If setting/clearing a repeated field/map that was objects, check the class before checking the autocreator. - Just to be paranoid, don’t mutate within copy/mutableCopy for the autocreated classes to ensure there is less chance of issues if someone does something really crazy threading wise. - Some more tests for the internal AutocreatedArray/AutocreatedDictionary classes to ensure things are working as expected. - Add Xcode 8.2 to the full_mac_build.sh supported list. * Fix generation of extending nested messages in JavaScript (#2439) * Fix generation of extending nested messages in JavaScript * Added missing test8.proto to build * Fix generated code when there is no namespace but there is enum definition. * Decoding unknown field should succeed. * Add embed.cc in src/Makefile.am to fix dist check. * Fixed "make distcheck" for the Autotools build To make the test pass I needed to fix out-of-tree builds and update EXTRA_DIST and CLEANFILES. * Remove redundent embed.cc from src/Makefile.am * Update version number to 3.2.0-rc.1 (#2578) * Change protoc-artifacts version to 3.2.0-rc.1 * Update version number to 3.2.0rc2 * Update change logs for 3.2.0 release. * Update php README * Update upb, fixes some bugs (including a hash table problem). (#2611) * Update upb, fixes some bugs (including a hash table problem). * Ruby: added a test for the previous hash table corruption. Verified that this triggers the bug in the currently released version. * Ruby: bugfix for SEGV. * Ruby: removed old code for dup'ing defs. * Reverting deployment target to 7.0 (#2618) The Protobuf library doesn’t require the 7.1 deployment target so reverting it back to 7.0 * Fix typo that breaks builds on big-endian (#2632) * Bump version number to 3.2.0
2017-01-31 17:17:32 +00:00
/**
* If the array contains an extension object in its last position, then the
* object is kept in place and its position is used as the pivot. If not,
* decides the pivot of the message based on suggestedPivot without
* materializing the extension object.
*
* @param {!jspb.Message} msg The JsPb proto to modify.
* @param {number} suggestedPivot See description for initialize().
* @private
*/
jspb.Message.initPivotAndExtensionObject_ = function(msg, suggestedPivot) {
2018-08-09 00:00:41 +00:00
// There are 3 variants that need to be dealt with which are the
// combination of whether there exists an extension object (EO) and
// whether there is a suggested pivot (SP).
//
// EO, ? : pivot is the index of the EO
// no-EO, no-SP: pivot is MAX_INT
// no-EO, SP : pivot is the max(lastindex + 1, SP)
var msgLength = msg.array.length;
var lastIndex = -1;
if (msgLength) {
lastIndex = msgLength - 1;
var obj = msg.array[lastIndex];
if (jspb.Message.isExtensionObject_(obj)) {
2018-08-09 00:00:41 +00:00
msg.pivot_ = jspb.Message.getFieldNumber_(msg, lastIndex);
msg.extensionObject_ = obj;
return;
}
}
if (suggestedPivot > -1) {
2018-08-09 00:00:41 +00:00
// If a extension object is not present, set the pivot value as being
// after the last value in the array to avoid overwriting values, etc.
msg.pivot_ = Math.max(
suggestedPivot, jspb.Message.getFieldNumber_(msg, lastIndex + 1));
// Avoid changing the shape of the proto with an empty extension object by
// deferring the materialization of the extension object until the first
// time a field set into it (may be due to getting a repeated proto field
// from it, in which case a new empty array is set into it at first).
msg.extensionObject_ = null;
} else {
// suggestedPivot is -1, which means that we don't have an extension object
// at all, in which case all fields are stored in the array.
msg.pivot_ = Number.MAX_VALUE;
}
};
/**
* Creates an empty extensionObject_ if non exists.
* @param {!jspb.Message} msg The JsPb proto to modify.
* @private
*/
jspb.Message.maybeInitEmptyExtensionObject_ = function(msg) {
var pivotIndex = jspb.Message.getIndex_(msg, msg.pivot_);
if (!msg.array[pivotIndex]) {
msg.extensionObject_ = msg.array[pivotIndex] = {};
}
};
/**
* Converts a JsPb repeated message field into an object list.
* @param {!Array<T>} field The repeated message field to be
* converted.
* @param {?function(boolean=): Object|
* function((boolean|undefined),T): Object} toObjectFn The toObject
* function for this field. We need to pass this for effective dead code
* removal.
* @param {boolean=} opt_includeInstance Whether to include the JSPB instance
* for transitional soy proto support: http://goto/soy-param-migration
* @return {!Array<Object>} An array of converted message objects.
* @template T
*/
jspb.Message.toObjectList = function(field, toObjectFn, opt_includeInstance) {
// Not using goog.array.map in the generated code to keep it small.
// And not using it here to avoid a function call.
var result = [];
for (var i = 0; i < field.length; i++) {
result[i] = toObjectFn.call(field[i], opt_includeInstance, field[i]);
}
return result;
};
/**
* Adds a proto's extension data to a Soy rendering object.
* @param {!jspb.Message} proto The proto whose extensions to convert.
* @param {!Object} obj The Soy object to add converted extension data to.
* @param {!Object} extensions The proto class' registered extensions.
2016-03-30 18:39:59 +00:00
* @param {function(this:?, jspb.ExtensionFieldInfo) : *} getExtensionFn
* The proto class' getExtension function. Passed for effective dead code
* removal.
* @param {boolean=} opt_includeInstance Whether to include the JSPB instance
* for transitional soy proto support: http://goto/soy-param-migration
*/
jspb.Message.toObjectExtension = function(proto, obj, extensions,
getExtensionFn, opt_includeInstance) {
for (var fieldNumber in extensions) {
var fieldInfo = extensions[fieldNumber];
var value = getExtensionFn.call(proto, fieldInfo);
if (value != null) {
for (var name in fieldInfo.fieldName) {
if (fieldInfo.fieldName.hasOwnProperty(name)) {
break; // the compiled field name
}
}
if (!fieldInfo.toObjectFn) {
obj[name] = value;
} else {
if (fieldInfo.isRepeated) {
obj[name] = jspb.Message.toObjectList(
/** @type {!Array<!jspb.Message>} */ (value),
fieldInfo.toObjectFn, opt_includeInstance);
} else {
obj[name] = fieldInfo.toObjectFn(
opt_includeInstance, /** @type {!jspb.Message} */ (value));
}
}
}
}
};
/**
* Writes a proto's extension data to a binary-format output stream.
* @param {!jspb.Message} proto The proto whose extensions to convert.
* @param {*} writer The binary-format writer to write to.
* @param {!Object} extensions The proto class' registered extensions.
2017-03-29 21:32:48 +00:00
* @param {function(this:jspb.Message,!jspb.ExtensionFieldInfo) : *} getExtensionFn The proto
* class' getExtension function. Passed for effective dead code removal.
*/
jspb.Message.serializeBinaryExtensions = function(proto, writer, extensions,
getExtensionFn) {
for (var fieldNumber in extensions) {
var binaryFieldInfo = extensions[fieldNumber];
var fieldInfo = binaryFieldInfo.fieldInfo;
// The old codegen doesn't add the extra fields to ExtensionFieldInfo, so we
// need to gracefully error-out here rather than produce a null dereference
// below.
if (!binaryFieldInfo.binaryWriterFn) {
throw new Error('Message extension present that was generated ' +
'without binary serialization support');
}
var value = getExtensionFn.call(proto, fieldInfo);
if (value != null) {
2016-03-30 18:39:59 +00:00
if (fieldInfo.isMessageType()) {
// If the message type of the extension was generated without binary
// support, there may not be a binary message serializer function, and
// we can't know when we codegen the extending message that the extended
// message may require binary support, so we can *only* catch this error
// here, at runtime (and this decoupled codegen is the whole point of
// extensions!).
if (binaryFieldInfo.binaryMessageSerializeFn) {
binaryFieldInfo.binaryWriterFn.call(writer, fieldInfo.fieldIndex,
value, binaryFieldInfo.binaryMessageSerializeFn);
} else {
throw new Error('Message extension present holding submessage ' +
'without binary support enabled, and message is ' +
'being serialized to binary format');
}
} else {
binaryFieldInfo.binaryWriterFn.call(
writer, fieldInfo.fieldIndex, value);
}
}
}
};
/**
* Reads an extension field from the given reader and, if a valid extension,
* sets the extension value.
* @param {!jspb.Message} msg A jspb proto.
* @param {!jspb.BinaryReader} reader
* @param {!Object} extensions The extensions object.
2017-03-29 21:32:48 +00:00
* @param {function(this:jspb.Message,!jspb.ExtensionFieldInfo)} getExtensionFn
* @param {function(this:jspb.Message,!jspb.ExtensionFieldInfo, ?)} setExtensionFn
*/
jspb.Message.readBinaryExtension = function(msg, reader, extensions,
getExtensionFn, setExtensionFn) {
var binaryFieldInfo = extensions[reader.getFieldNumber()];
if (!binaryFieldInfo) {
reader.skipField();
return;
}
var fieldInfo = binaryFieldInfo.fieldInfo;
if (!binaryFieldInfo.binaryReaderFn) {
throw new Error('Deserializing extension whose generated code does not ' +
'support binary format');
}
var value;
2016-03-30 18:39:59 +00:00
if (fieldInfo.isMessageType()) {
value = new fieldInfo.ctor();
binaryFieldInfo.binaryReaderFn.call(
reader, value, binaryFieldInfo.binaryMessageDeserializeFn);
} else {
// All other types.
value = binaryFieldInfo.binaryReaderFn.call(reader);
}
if (fieldInfo.isRepeated && !binaryFieldInfo.isPacked) {
var currentList = getExtensionFn.call(msg, fieldInfo);
if (!currentList) {
setExtensionFn.call(msg, fieldInfo, [value]);
} else {
currentList.push(value);
}
} else {
setExtensionFn.call(msg, fieldInfo, value);
}
};
/**
* Gets the value of a non-extension field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @return {string|number|boolean|Uint8Array|Array|null|undefined}
* The field's value.
* @protected
*/
jspb.Message.getField = function(msg, fieldNumber) {
if (fieldNumber < msg.pivot_) {
var index = jspb.Message.getIndex_(msg, fieldNumber);
var val = msg.array[index];
if (val === jspb.Message.EMPTY_LIST_SENTINEL_) {
return msg.array[index] = [];
}
return val;
} else {
if (!msg.extensionObject_) {
return undefined;
}
var val = msg.extensionObject_[fieldNumber];
if (val === jspb.Message.EMPTY_LIST_SENTINEL_) {
return msg.extensionObject_[fieldNumber] = [];
}
return val;
}
};
/**
* Gets the value of a non-extension repeated field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @return {!Array}
* The field's value.
* @protected
*/
jspb.Message.getRepeatedField = function(msg, fieldNumber) {
2019-02-22 10:13:33 +00:00
return /** @type {!Array} */ (jspb.Message.getField(msg, fieldNumber));
};
2016-03-30 18:39:59 +00:00
/**
* Gets the value of an optional float or double field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @return {?number|undefined} The field's value.
* @protected
*/
jspb.Message.getOptionalFloatingPointField = function(msg, fieldNumber) {
var value = jspb.Message.getField(msg, fieldNumber);
// Converts "NaN", "Infinity" and "-Infinity" to their corresponding numbers.
return value == null ? value : +value;
};
/**
* Gets the value of an optional boolean field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @return {?boolean|undefined} The field's value.
* @protected
*/
jspb.Message.getBooleanField = function(msg, fieldNumber) {
var value = jspb.Message.getField(msg, fieldNumber);
// TODO(b/122673075): always return null when the value is null-ish.
return value == null ? (value) : !!value;
};
2016-03-30 18:39:59 +00:00
/**
* Gets the value of a repeated float or double field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @return {!Array<number>} The field's value.
* @protected
*/
jspb.Message.getRepeatedFloatingPointField = function(msg, fieldNumber) {
var values = jspb.Message.getRepeatedField(msg, fieldNumber);
if (!msg.convertedPrimitiveFields_) {
msg.convertedPrimitiveFields_ = {};
2016-03-30 18:39:59 +00:00
}
if (!msg.convertedPrimitiveFields_[fieldNumber]) {
2016-03-30 18:39:59 +00:00
for (var i = 0; i < values.length; i++) {
// Converts "NaN", "Infinity" and "-Infinity" to their corresponding
// numbers.
values[i] = +values[i];
}
msg.convertedPrimitiveFields_[fieldNumber] = true;
2016-03-30 18:39:59 +00:00
}
return /** @type {!Array<number>} */ (values);
};
/**
* Gets the value of a repeated boolean field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @return {!Array<boolean>} The field's value.
* @protected
*/
jspb.Message.getRepeatedBooleanField = function(msg, fieldNumber) {
var values = jspb.Message.getRepeatedField(msg, fieldNumber);
if (!msg.convertedPrimitiveFields_) {
msg.convertedPrimitiveFields_ = {};
}
if (!msg.convertedPrimitiveFields_[fieldNumber]) {
for (var i = 0; i < values.length; i++) {
// Converts 0 and 1 to their corresponding booleans.
values[i] = !!values[i];
}
msg.convertedPrimitiveFields_[fieldNumber] = true;
}
return /** @type {!Array<boolean>} */ (values);
};
2016-03-30 18:39:59 +00:00
/**
* Coerce a 'bytes' field to a base 64 string.
* @param {string|Uint8Array|null} value
* @return {?string} The field's coerced value.
*/
jspb.Message.bytesAsB64 = function(value) {
if (value == null || goog.isString(value)) {
return value;
}
if (jspb.Message.SUPPORTS_UINT8ARRAY_ && value instanceof Uint8Array) {
return goog.crypt.base64.encodeByteArray(value);
}
goog.asserts.fail('Cannot coerce to b64 string: ' + goog.typeOf(value));
return null;
};
/**
* Coerce a 'bytes' field to a Uint8Array byte buffer.
* Note that Uint8Array is not supported on IE versions before 10 nor on Opera
* Mini. @see http://caniuse.com/Uint8Array
* @param {string|Uint8Array|null} value
* @return {?Uint8Array} The field's coerced value.
*/
jspb.Message.bytesAsU8 = function(value) {
if (value == null || value instanceof Uint8Array) {
return value;
}
if (goog.isString(value)) {
return goog.crypt.base64.decodeStringToUint8Array(value);
}
goog.asserts.fail('Cannot coerce to Uint8Array: ' + goog.typeOf(value));
return null;
};
/**
* Coerce a repeated 'bytes' field to an array of base 64 strings.
* Note: the returned array should be treated as immutable.
* @param {!Array<string>|!Array<!Uint8Array>} value
* @return {!Array<string?>} The field's coerced value.
*/
jspb.Message.bytesListAsB64 = function(value) {
jspb.Message.assertConsistentTypes_(value);
if (!value.length || goog.isString(value[0])) {
return /** @type {!Array<string>} */ (value);
}
return goog.array.map(value, jspb.Message.bytesAsB64);
};
/**
* Coerce a repeated 'bytes' field to an array of Uint8Array byte buffers.
* Note: the returned array should be treated as immutable.
* Note that Uint8Array is not supported on IE versions before 10 nor on Opera
* Mini. @see http://caniuse.com/Uint8Array
* @param {!Array<string>|!Array<!Uint8Array>} value
* @return {!Array<Uint8Array?>} The field's coerced value.
*/
jspb.Message.bytesListAsU8 = function(value) {
jspb.Message.assertConsistentTypes_(value);
if (!value.length || value[0] instanceof Uint8Array) {
return /** @type {!Array<!Uint8Array>} */ (value);
}
return goog.array.map(value, jspb.Message.bytesAsU8);
};
/**
* Asserts that all elements of an array are of the same type.
* @param {Array?} array The array to test.
* @private
*/
jspb.Message.assertConsistentTypes_ = function(array) {
if (goog.DEBUG && array && array.length > 1) {
var expected = goog.typeOf(array[0]);
goog.array.forEach(array, function(e) {
if (goog.typeOf(e) != expected) {
goog.asserts.fail('Inconsistent type in JSPB repeated field array. ' +
'Got ' + goog.typeOf(e) + ' expected ' + expected);
}
});
}
};
/**
* Gets the value of a non-extension primitive field, with proto3 (non-nullable
* primitives) semantics. Returns `defaultValue` if the field is not otherwise
* set.
* @template T
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {T} defaultValue The default value.
* @return {T} The field's value.
* @protected
*/
2016-09-19 20:45:07 +00:00
jspb.Message.getFieldWithDefault = function(msg, fieldNumber, defaultValue) {
var value = jspb.Message.getField(msg, fieldNumber);
if (value == null) {
return defaultValue;
} else {
return value;
}
};
/**
* Gets the value of a boolean field, with proto3 (non-nullable primitives)
* semantics. Returns `defaultValue` if the field is not otherwise set.
* @template T
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {boolean} defaultValue The default value.
* @return {boolean} The field's value.
* @protected
*/
jspb.Message.getBooleanFieldWithDefault = function(
msg, fieldNumber, defaultValue) {
var value = jspb.Message.getBooleanField(msg, fieldNumber);
if (value == null) {
return defaultValue;
} else {
return value;
}
};
/**
* Gets the value of a floating point field, with proto3 (non-nullable
* primitives) semantics. Returns `defaultValue` if the field is not otherwise
* set.
* @template T
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {number} defaultValue The default value.
* @return {number} The field's value.
* @protected
*/
jspb.Message.getFloatingPointFieldWithDefault = function(
msg, fieldNumber, defaultValue) {
var value = jspb.Message.getOptionalFloatingPointField(msg, fieldNumber);
if (value == null) {
return defaultValue;
} else {
return value;
}
};
/**
* Alias for getFieldWithDefault used by older generated code.
* @template T
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {T} defaultValue The default value.
* @return {T} The field's value.
* @protected
*/
jspb.Message.getFieldProto3 = jspb.Message.getFieldWithDefault;
/**
* Gets the value of a map field, lazily creating the map container if
* necessary.
*
* This should only be called from generated code, because it requires knowledge
* of serialization/parsing callbacks (which are required by the map at
* construction time, and the map may be constructed here).
*
* @template K, V
* @param {!jspb.Message} msg
* @param {number} fieldNumber
* @param {boolean|undefined} noLazyCreate
* @param {?=} opt_valueCtor
* @return {!jspb.Map<K, V>|undefined}
* @protected
*/
jspb.Message.getMapField = function(msg, fieldNumber, noLazyCreate,
opt_valueCtor) {
if (!msg.wrappers_) {
msg.wrappers_ = {};
}
// If we already have a map in the map wrappers, return that.
if (fieldNumber in msg.wrappers_) {
return msg.wrappers_[fieldNumber];
} else if (noLazyCreate) {
return undefined;
} else {
// Wrap the underlying elements array with a Map.
var arr = jspb.Message.getField(msg, fieldNumber);
if (!arr) {
arr = [];
jspb.Message.setField(msg, fieldNumber, arr);
}
return msg.wrappers_[fieldNumber] =
new jspb.Map(
/** @type {!Array<!Array<!Object>>} */ (arr), opt_valueCtor);
}
};
/**
* Sets the value of a non-extension field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {string|number|boolean|Uint8Array|Array|undefined} value New value
* @protected
*/
jspb.Message.setField = function(msg, fieldNumber, value) {
if (fieldNumber < msg.pivot_) {
msg.array[jspb.Message.getIndex_(msg, fieldNumber)] = value;
} else {
jspb.Message.maybeInitEmptyExtensionObject_(msg);
msg.extensionObject_[fieldNumber] = value;
}
};
/**
* Sets the value of a non-extension integer field of a proto3
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {number} value New value
* @protected
*/
jspb.Message.setProto3IntField = function(msg, fieldNumber, value) {
jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, 0);
};
/**
* Sets the value of a non-extension floating point field of a proto3
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {number} value New value
* @protected
*/
jspb.Message.setProto3FloatField = function(msg, fieldNumber, value) {
jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, 0.0);
};
/**
* Sets the value of a non-extension boolean field of a proto3
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {boolean} value New value
* @protected
*/
jspb.Message.setProto3BooleanField = function(msg, fieldNumber, value) {
jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, false);
};
/**
* Sets the value of a non-extension String field of a proto3
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {string} value New value
* @protected
*/
jspb.Message.setProto3StringField = function(msg, fieldNumber, value) {
jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, "");
};
/**
* Sets the value of a non-extension Bytes field of a proto3
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {!Uint8Array|string} value New value
* @protected
*/
jspb.Message.setProto3BytesField = function(msg, fieldNumber, value) {
jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, "");
};
/**
* Sets the value of a non-extension enum field of a proto3
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {number} value New value
* @protected
*/
jspb.Message.setProto3EnumField = function(msg, fieldNumber, value) {
jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, 0);
};
2018-08-09 00:00:41 +00:00
/**
* Sets the value of a non-extension int field of a proto3 that has jstype set
* to String.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {string} value New value
* @protected
*/
jspb.Message.setProto3StringIntField = function(msg, fieldNumber, value) {
jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, "0");
};
/**
* Sets the value of a non-extension primitive field, with proto3 (non-nullable
* primitives) semantics of ignoring values that are equal to the type's
* default.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {!Uint8Array|string|number|boolean|undefined} value New value
* @param {!Uint8Array|string|number|boolean} defaultValue The default value.
* @private
*/
jspb.Message.setFieldIgnoringDefault_ = function(
msg, fieldNumber, value, defaultValue) {
2018-08-09 00:00:41 +00:00
if (value !== defaultValue) {
jspb.Message.setField(msg, fieldNumber, value);
} else {
msg.array[jspb.Message.getIndex_(msg, fieldNumber)] = null;
}
};
2016-09-19 20:45:07 +00:00
/**
* Adds a value to a repeated, primitive field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {string|number|boolean|!Uint8Array} value New value
* @param {number=} opt_index Index where to put new value.
* @protected
*/
jspb.Message.addToRepeatedField = function(msg, fieldNumber, value, opt_index) {
var arr = jspb.Message.getRepeatedField(msg, fieldNumber);
2016-09-19 20:45:07 +00:00
if (opt_index != undefined) {
arr.splice(opt_index, 0, value);
} else {
arr.push(value);
}
};
/**
* Sets the value of a field in a oneof union and clears all other fields in
* the union.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {!Array<number>} oneof The fields belonging to the union.
* @param {string|number|boolean|Uint8Array|Array|undefined} value New value
* @protected
*/
jspb.Message.setOneofField = function(msg, fieldNumber, oneof, value) {
var currentCase = jspb.Message.computeOneofCase(msg, oneof);
if (currentCase && currentCase !== fieldNumber && value !== undefined) {
if (msg.wrappers_ && currentCase in msg.wrappers_) {
msg.wrappers_[currentCase] = undefined;
}
jspb.Message.setField(msg, currentCase, undefined);
}
jspb.Message.setField(msg, fieldNumber, value);
};
/**
* Computes the selection in a oneof group for the given message, ensuring
* only one field is set in the process.
*
* According to the protobuf language guide (
* https://developers.google.com/protocol-buffers/docs/proto#oneof), "if the
* parser encounters multiple members of the same oneof on the wire, only the
* last member seen is used in the parsed message." Since JSPB serializes
* messages to a JSON array, the "last member seen" will always be the field
* with the greatest field number (directly corresponding to the greatest
* array index).
*
* @param {!jspb.Message} msg A jspb proto.
* @param {!Array<number>} oneof The field numbers belonging to the union.
* @return {number} The field number currently set in the union, or 0 if none.
* @protected
*/
jspb.Message.computeOneofCase = function(msg, oneof) {
var oneofField;
var oneofValue;
for (var i = 0; i < oneof.length; i++) {
var fieldNumber = oneof[i];
var value = jspb.Message.getField(msg, fieldNumber);
if (value != null) {
oneofField = fieldNumber;
oneofValue = value;
jspb.Message.setField(msg, fieldNumber, undefined);
}
}
if (oneofField) {
// NB: We know the value is unique, so we can call jspb.Message.setField
// directly instead of jpsb.Message.setOneofField. Also, setOneofField
// calls this function.
jspb.Message.setField(msg, oneofField, oneofValue);
return oneofField;
}
return 0;
};
/**
* Gets and wraps a proto field on access.
* @param {!jspb.Message} msg A jspb proto.
* @param {function(new:jspb.Message, Array)} ctor Constructor for the field.
* @param {number} fieldNumber The field number.
* @param {number=} opt_required True (1) if this is a required field.
* @return {jspb.Message} The field as a jspb proto.
* @protected
*/
jspb.Message.getWrapperField = function(msg, ctor, fieldNumber, opt_required) {
// TODO(mwr): Consider copying data and/or arrays.
if (!msg.wrappers_) {
msg.wrappers_ = {};
}
if (!msg.wrappers_[fieldNumber]) {
var data = /** @type {Array} */ (jspb.Message.getField(msg, fieldNumber));
if (opt_required || data) {
// TODO(mwr): Remove existence test for always valid default protos.
msg.wrappers_[fieldNumber] = new ctor(data);
}
}
return /** @type {jspb.Message} */ (msg.wrappers_[fieldNumber]);
};
/**
* Gets and wraps a repeated proto field on access.
* @param {!jspb.Message} msg A jspb proto.
* @param {function(new:jspb.Message, Array)} ctor Constructor for the field.
* @param {number} fieldNumber The field number.
2018-08-09 00:00:41 +00:00
* @return {!Array<!jspb.Message>} The repeated field as an array of protos.
* @protected
*/
jspb.Message.getRepeatedWrapperField = function(msg, ctor, fieldNumber) {
2016-09-19 20:45:07 +00:00
jspb.Message.wrapRepeatedField_(msg, ctor, fieldNumber);
var val = msg.wrappers_[fieldNumber];
if (val == jspb.Message.EMPTY_LIST_SENTINEL_) {
val = msg.wrappers_[fieldNumber] = [];
}
return /** @type {!Array<!jspb.Message>} */ (val);
};
/**
* Wraps underlying array into proto message representation if it wasn't done
* before.
* @param {!jspb.Message} msg A jspb proto.
* @param {function(new:jspb.Message, ?Array)} ctor Constructor for the field.
* @param {number} fieldNumber The field number.
* @private
*/
jspb.Message.wrapRepeatedField_ = function(msg, ctor, fieldNumber) {
if (!msg.wrappers_) {
msg.wrappers_ = {};
}
if (!msg.wrappers_[fieldNumber]) {
var data = jspb.Message.getRepeatedField(msg, fieldNumber);
for (var wrappers = [], i = 0; i < data.length; i++) {
wrappers[i] = new ctor(data[i]);
}
msg.wrappers_[fieldNumber] = wrappers;
}
};
/**
* Sets a proto field and syncs it to the backing array.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {?jspb.Message|?jspb.Map|undefined} value A new value for this proto
* field.
* @protected
*/
jspb.Message.setWrapperField = function(msg, fieldNumber, value) {
if (!msg.wrappers_) {
msg.wrappers_ = {};
}
var data = value ? value.toArray() : value;
msg.wrappers_[fieldNumber] = value;
jspb.Message.setField(msg, fieldNumber, data);
};
/**
* Sets a proto field in a oneof union and syncs it to the backing array.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {!Array<number>} oneof The fields belonging to the union.
* @param {jspb.Message|undefined} value A new value for this proto field.
* @protected
*/
jspb.Message.setOneofWrapperField = function(msg, fieldNumber, oneof, value) {
if (!msg.wrappers_) {
msg.wrappers_ = {};
}
var data = value ? value.toArray() : value;
msg.wrappers_[fieldNumber] = value;
jspb.Message.setOneofField(msg, fieldNumber, oneof, data);
};
/**
* Sets a repeated proto field and syncs it to the backing array.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {Array<!jspb.Message>|undefined} value An array of protos.
* @protected
*/
jspb.Message.setRepeatedWrapperField = function(msg, fieldNumber, value) {
if (!msg.wrappers_) {
msg.wrappers_ = {};
}
value = value || [];
for (var data = [], i = 0; i < value.length; i++) {
data[i] = value[i].toArray();
}
msg.wrappers_[fieldNumber] = value;
jspb.Message.setField(msg, fieldNumber, data);
};
2016-09-19 20:45:07 +00:00
/**
* Add a message to a repeated proto field.
* @param {!jspb.Message} msg A jspb proto.
* @param {number} fieldNumber The field number.
* @param {T_CHILD|undefined} value Proto that will be added to the
* repeated field.
* @param {function(new:T_CHILD, ?Array=)} ctor The constructor of the
* message type.
* @param {number|undefined} index Index at which to insert the value.
* @return {T_CHILD_NOT_UNDEFINED} proto that was inserted to the repeated field
* @template MessageType
* Use go/closure-ttl to declare a non-undefined version of T_CHILD. Replace the
* undefined in blah|undefined with none. This is necessary because the compiler
* will infer T_CHILD to be |undefined.
* @template T_CHILD
* @template T_CHILD_NOT_UNDEFINED :=
* cond(isUnknown(T_CHILD), unknown(),
* mapunion(T_CHILD, (X) =>
* cond(eq(X, 'undefined'), none(), X)))
* =:
* @protected
*/
jspb.Message.addToRepeatedWrapperField = function(
msg, fieldNumber, value, ctor, index) {
jspb.Message.wrapRepeatedField_(msg, ctor, fieldNumber);
var wrapperArray = msg.wrappers_[fieldNumber];
if (!wrapperArray) {
wrapperArray = msg.wrappers_[fieldNumber] = [];
}
var insertedValue = value ? value : new ctor();
var array = jspb.Message.getRepeatedField(msg, fieldNumber);
2016-09-19 20:45:07 +00:00
if (index != undefined) {
wrapperArray.splice(index, 0, insertedValue);
array.splice(index, 0, insertedValue.toArray());
} else {
wrapperArray.push(insertedValue);
array.push(insertedValue.toArray());
}
return insertedValue;
};
/**
* Converts a JsPb repeated message field into a map. The map will contain
* protos unless an optional toObject function is given, in which case it will
* contain objects suitable for Soy rendering.
* @param {!Array<T>} field The repeated message field to be
* converted.
* @param {function() : string?} mapKeyGetterFn The function to get the key of
* the map.
* @param {?function(boolean=): Object|
* function((boolean|undefined),T): Object} opt_toObjectFn The
* toObject function for this field. We need to pass this for effective
* dead code removal.
* @param {boolean=} opt_includeInstance Whether to include the JSPB instance
* for transitional soy proto support: http://goto/soy-param-migration
* @return {!Object<string, Object>} A map of proto or Soy objects.
* @template T
*/
jspb.Message.toMap = function(
field, mapKeyGetterFn, opt_toObjectFn, opt_includeInstance) {
var result = {};
for (var i = 0; i < field.length; i++) {
result[mapKeyGetterFn.call(field[i])] = opt_toObjectFn ?
opt_toObjectFn.call(field[i], opt_includeInstance,
/** @type {!jspb.Message} */ (field[i])) : field[i];
}
return result;
};
/**
* Syncs all map fields' contents back to their underlying arrays.
* @private
*/
jspb.Message.prototype.syncMapFields_ = function() {
// This iterates over submessage, map, and repeated fields, which is intended.
// Submessages can contain maps which also need to be synced.
//
// There is a lot of opportunity for optimization here. For example we could
// statically determine that some messages have no submessages with maps and
// optimize this method away for those just by generating one extra static
// boolean per message type.
if (this.wrappers_) {
for (var fieldNumber in this.wrappers_) {
var val = this.wrappers_[fieldNumber];
if (goog.isArray(val)) {
for (var i = 0; i < val.length; i++) {
if (val[i]) {
val[i].toArray();
}
}
} else {
// Works for submessages and maps.
if (val) {
val.toArray();
}
}
}
}
};
/**
* Returns the internal array of this proto.
* <p>Note: If you use this array to construct a second proto, the content
* would then be partially shared between the two protos.
* @return {!Array} The proto represented as an array.
*/
jspb.Message.prototype.toArray = function() {
this.syncMapFields_();
return this.array;
};
Merge 3.2.x branch into master (#2648) * Down-integrate internal changes to github. * Update conformance test failure list. * Explicitly import used class in nano test to avoid random test fail. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * maps_test.js: check whether Symbol is defined before using it (#2524) Symbol is not yet available on older versions of Node.js and so this test fails with them. This change just directly checks whether Symbol is available before we try to use it. * Added well_known_types_embed.cc to CLEANFILES so that it gets cleaned up * Updated Makefile.am to fix out-of-tree builds * Added Bazel genrule for generating well_known_types_embed.cc In pull request #2517 I made this change for the CMake and autotools builds but forgot to do it for the Bazel build. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * Add new js file in extra dist. * Bump version number to 3.2.0 * Fixed issue with autoloading - Invalid paths (#2538) * PHP fix int64 decoding (#2516) * fix int64 decoding * fix int64 decoding + tests * Fix int64 decoding on 32-bit machines. * Fix warning in compiler/js/embed.cc embed.cc: In function ‘std::string CEscape(const string&)’: embed.cc:51:32: warning: comparison between signed and unsigned integer expressions [-Wsign-compare] for (int i = 0; i < str.size(); ++i) { ^ * Fix include in auto-generated well_known_types_embed.cc Restore include style fix (e3da722) that has been trampled by auto-generation of well_known_types_embed.cc * Fixed cross compilations with the Autotools build Pull request #2517 caused cross compilations to start failing, because the js_embed binary was being built to run on the target platform instead of on the build machine. This change updates the Autotools build to use the AX_PROG_CXX_FOR_BUILD macro to find a suitable compiler for the build machine and always use that when building js_embed. * Minor fix for autocreated object repeated fields and maps. - If setting/clearing a repeated field/map that was objects, check the class before checking the autocreator. - Just to be paranoid, don’t mutate within copy/mutableCopy for the autocreated classes to ensure there is less chance of issues if someone does something really crazy threading wise. - Some more tests for the internal AutocreatedArray/AutocreatedDictionary classes to ensure things are working as expected. - Add Xcode 8.2 to the full_mac_build.sh supported list. * Fix generation of extending nested messages in JavaScript (#2439) * Fix generation of extending nested messages in JavaScript * Added missing test8.proto to build * Fix generated code when there is no namespace but there is enum definition. * Decoding unknown field should succeed. * Add embed.cc in src/Makefile.am to fix dist check. * Fixed "make distcheck" for the Autotools build To make the test pass I needed to fix out-of-tree builds and update EXTRA_DIST and CLEANFILES. * Remove redundent embed.cc from src/Makefile.am * Update version number to 3.2.0-rc.1 (#2578) * Change protoc-artifacts version to 3.2.0-rc.1 * Update version number to 3.2.0rc2 * Update change logs for 3.2.0 release. * Update php README * Update upb, fixes some bugs (including a hash table problem). (#2611) * Update upb, fixes some bugs (including a hash table problem). * Ruby: added a test for the previous hash table corruption. Verified that this triggers the bug in the currently released version. * Ruby: bugfix for SEGV. * Ruby: removed old code for dup'ing defs. * Reverting deployment target to 7.0 (#2618) The Protobuf library doesn’t require the 7.1 deployment target so reverting it back to 7.0 * Fix typo that breaks builds on big-endian (#2632) * Bump version number to 3.2.0
2017-01-31 17:17:32 +00:00
if (jspb.Message.GENERATE_TO_STRING) {
/**
* Creates a string representation of the internal data array of this proto.
* <p>NOTE: This string is *not* suitable for use in server requests.
* @return {string} A string representation of this proto.
* @override
*/
jspb.Message.prototype.toString = function() {
this.syncMapFields_();
return this.array.toString();
};
Merge 3.2.x branch into master (#2648) * Down-integrate internal changes to github. * Update conformance test failure list. * Explicitly import used class in nano test to avoid random test fail. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * maps_test.js: check whether Symbol is defined before using it (#2524) Symbol is not yet available on older versions of Node.js and so this test fails with them. This change just directly checks whether Symbol is available before we try to use it. * Added well_known_types_embed.cc to CLEANFILES so that it gets cleaned up * Updated Makefile.am to fix out-of-tree builds * Added Bazel genrule for generating well_known_types_embed.cc In pull request #2517 I made this change for the CMake and autotools builds but forgot to do it for the Bazel build. * Update _GNUC_VER to use the correct implementation of atomic operation on Mac. * Add new js file in extra dist. * Bump version number to 3.2.0 * Fixed issue with autoloading - Invalid paths (#2538) * PHP fix int64 decoding (#2516) * fix int64 decoding * fix int64 decoding + tests * Fix int64 decoding on 32-bit machines. * Fix warning in compiler/js/embed.cc embed.cc: In function ‘std::string CEscape(const string&)’: embed.cc:51:32: warning: comparison between signed and unsigned integer expressions [-Wsign-compare] for (int i = 0; i < str.size(); ++i) { ^ * Fix include in auto-generated well_known_types_embed.cc Restore include style fix (e3da722) that has been trampled by auto-generation of well_known_types_embed.cc * Fixed cross compilations with the Autotools build Pull request #2517 caused cross compilations to start failing, because the js_embed binary was being built to run on the target platform instead of on the build machine. This change updates the Autotools build to use the AX_PROG_CXX_FOR_BUILD macro to find a suitable compiler for the build machine and always use that when building js_embed. * Minor fix for autocreated object repeated fields and maps. - If setting/clearing a repeated field/map that was objects, check the class before checking the autocreator. - Just to be paranoid, don’t mutate within copy/mutableCopy for the autocreated classes to ensure there is less chance of issues if someone does something really crazy threading wise. - Some more tests for the internal AutocreatedArray/AutocreatedDictionary classes to ensure things are working as expected. - Add Xcode 8.2 to the full_mac_build.sh supported list. * Fix generation of extending nested messages in JavaScript (#2439) * Fix generation of extending nested messages in JavaScript * Added missing test8.proto to build * Fix generated code when there is no namespace but there is enum definition. * Decoding unknown field should succeed. * Add embed.cc in src/Makefile.am to fix dist check. * Fixed "make distcheck" for the Autotools build To make the test pass I needed to fix out-of-tree builds and update EXTRA_DIST and CLEANFILES. * Remove redundent embed.cc from src/Makefile.am * Update version number to 3.2.0-rc.1 (#2578) * Change protoc-artifacts version to 3.2.0-rc.1 * Update version number to 3.2.0rc2 * Update change logs for 3.2.0 release. * Update php README * Update upb, fixes some bugs (including a hash table problem). (#2611) * Update upb, fixes some bugs (including a hash table problem). * Ruby: added a test for the previous hash table corruption. Verified that this triggers the bug in the currently released version. * Ruby: bugfix for SEGV. * Ruby: removed old code for dup'ing defs. * Reverting deployment target to 7.0 (#2618) The Protobuf library doesn’t require the 7.1 deployment target so reverting it back to 7.0 * Fix typo that breaks builds on big-endian (#2632) * Bump version number to 3.2.0
2017-01-31 17:17:32 +00:00
}
/**
* Gets the value of the extension field from the extended object.
* @param {jspb.ExtensionFieldInfo<T>} fieldInfo Specifies the field to get.
* @return {T} The value of the field.
* @template T
*/
jspb.Message.prototype.getExtension = function(fieldInfo) {
if (!this.extensionObject_) {
return undefined;
}
if (!this.wrappers_) {
this.wrappers_ = {};
}
var fieldNumber = fieldInfo.fieldIndex;
if (fieldInfo.isRepeated) {
2016-03-30 18:39:59 +00:00
if (fieldInfo.isMessageType()) {
if (!this.wrappers_[fieldNumber]) {
this.wrappers_[fieldNumber] =
goog.array.map(this.extensionObject_[fieldNumber] || [],
function(arr) {
return new fieldInfo.ctor(arr);
});
}
return this.wrappers_[fieldNumber];
} else {
return this.extensionObject_[fieldNumber];
}
} else {
2016-03-30 18:39:59 +00:00
if (fieldInfo.isMessageType()) {
if (!this.wrappers_[fieldNumber] && this.extensionObject_[fieldNumber]) {
this.wrappers_[fieldNumber] = new fieldInfo.ctor(
/** @type {Array|undefined} */ (
this.extensionObject_[fieldNumber]));
}
return this.wrappers_[fieldNumber];
} else {
return this.extensionObject_[fieldNumber];
}
}
};
/**
* Sets the value of the extension field in the extended object.
* @param {jspb.ExtensionFieldInfo} fieldInfo Specifies the field to set.
2016-03-30 18:39:59 +00:00
* @param {jspb.Message|string|Uint8Array|number|boolean|Array?} value The value
* to set.
2016-09-19 20:45:07 +00:00
* @return {THIS} For chaining
* @this {THIS}
* @template THIS
*/
jspb.Message.prototype.setExtension = function(fieldInfo, value) {
2016-09-19 20:45:07 +00:00
// Cast self, since the inferred THIS is unknown inside the function body.
// https://github.com/google/closure-compiler/issues/1411#issuecomment-232442220
var self = /** @type {!jspb.Message} */ (this);
if (!self.wrappers_) {
self.wrappers_ = {};
}
2016-09-19 20:45:07 +00:00
jspb.Message.maybeInitEmptyExtensionObject_(self);
var fieldNumber = fieldInfo.fieldIndex;
if (fieldInfo.isRepeated) {
value = value || [];
2016-03-30 18:39:59 +00:00
if (fieldInfo.isMessageType()) {
2016-09-19 20:45:07 +00:00
self.wrappers_[fieldNumber] = value;
self.extensionObject_[fieldNumber] = goog.array.map(
/** @type {!Array<!jspb.Message>} */ (value), function(msg) {
return msg.toArray();
});
} else {
2016-09-19 20:45:07 +00:00
self.extensionObject_[fieldNumber] = value;
}
} else {
2016-03-30 18:39:59 +00:00
if (fieldInfo.isMessageType()) {
2016-09-19 20:45:07 +00:00
self.wrappers_[fieldNumber] = value;
self.extensionObject_[fieldNumber] =
value ? /** @type {!jspb.Message} */ (value).toArray() : value;
} else {
2016-09-19 20:45:07 +00:00
self.extensionObject_[fieldNumber] = value;
}
}
2016-09-19 20:45:07 +00:00
return self;
};
/**
* Creates a difference object between two messages.
*
* The result will contain the top-level fields of m2 that differ from those of
* m1 at any level of nesting. No data is cloned, the result object will
* share its top-level elements with m2 (but not with m1).
*
* Note that repeated fields should not have null/undefined elements, but if
* they do, this operation will treat repeated fields of different length as
* the same if the only difference between them is due to trailing
* null/undefined values.
*
* @param {!jspb.Message} m1 The first message object.
* @param {!jspb.Message} m2 The second message object.
* @return {!jspb.Message} The difference returned as a proto message.
* Note that the returned message may be missing required fields. This is
* currently tolerated in Js, but would cause an error if you tried to
* send such a proto to the server. You can access the raw difference
* array with result.toArray().
* @throws {Error} If the messages are responses with different types.
*/
jspb.Message.difference = function(m1, m2) {
if (!(m1 instanceof m2.constructor)) {
throw new Error('Messages have different types.');
}
var arr1 = m1.toArray();
var arr2 = m2.toArray();
var res = [];
var start = 0;
var length = arr1.length > arr2.length ? arr1.length : arr2.length;
if (m1.getJsPbMessageId()) {
res[0] = m1.getJsPbMessageId();
start = 1;
}
for (var i = start; i < length; i++) {
if (!jspb.Message.compareFields(arr1[i], arr2[i])) {
res[i] = arr2[i];
}
}
return new m1.constructor(res);
};
/**
* Tests whether two messages are equal.
* @param {jspb.Message|undefined} m1 The first message object.
* @param {jspb.Message|undefined} m2 The second message object.
* @return {boolean} true if both messages are null/undefined, or if both are
* of the same type and have the same field values.
*/
jspb.Message.equals = function(m1, m2) {
return m1 == m2 || (!!(m1 && m2) && (m1 instanceof m2.constructor) &&
jspb.Message.compareFields(m1.toArray(), m2.toArray()));
};
2016-03-30 18:39:59 +00:00
/**
* Compares two message extension fields recursively.
* @param {!Object} extension1 The first field.
* @param {!Object} extension2 The second field.
* @return {boolean} true if the extensions are null/undefined, or otherwise
* equal.
*/
jspb.Message.compareExtensions = function(extension1, extension2) {
extension1 = extension1 || {};
extension2 = extension2 || {};
var keys = {};
for (var name in extension1) {
keys[name] = 0;
}
for (var name in extension2) {
keys[name] = 0;
}
for (name in keys) {
if (!jspb.Message.compareFields(extension1[name], extension2[name])) {
return false;
}
}
return true;
};
/**
* Compares two message fields recursively.
* @param {*} field1 The first field.
* @param {*} field2 The second field.
* @return {boolean} true if the fields are null/undefined, or otherwise equal.
*/
jspb.Message.compareFields = function(field1, field2) {
2016-03-30 18:39:59 +00:00
// If the fields are trivially equal, they're equal.
if (field1 == field2) return true;
if (!goog.isObject(field1) || !goog.isObject(field2)) {
// NaN != NaN so we cover this case.
if ((goog.isNumber(field1) && isNaN(field1)) ||
(goog.isNumber(field2) && isNaN(field2))) {
// One of the fields might be a string 'NaN'.
return String(field1) == String(field2);
}
// If the fields aren't trivially equal and one of them isn't an object,
// they can't possibly be equal.
2016-03-30 18:39:59 +00:00
return false;
}
// We have two objects. If they're different types, they're not equal.
field1 = /** @type {!Object} */(field1);
field2 = /** @type {!Object} */(field2);
if (field1.constructor != field2.constructor) return false;
// If both are Uint8Arrays, compare them element-by-element.
if (jspb.Message.SUPPORTS_UINT8ARRAY_ && field1.constructor === Uint8Array) {
var bytes1 = /** @type {!Uint8Array} */(field1);
var bytes2 = /** @type {!Uint8Array} */(field2);
if (bytes1.length != bytes2.length) return false;
for (var i = 0; i < bytes1.length; i++) {
if (bytes1[i] != bytes2[i]) return false;
}
2016-03-30 18:39:59 +00:00
return true;
}
// If they're both Arrays, compare them element by element except for the
// optional extension objects at the end, which we compare separately.
if (field1.constructor === Array) {
var typedField1 = /** @type {!Array<?>} */ (field1);
var typedField2 = /** @type {!Array<?>} */ (field2);
2016-03-30 18:39:59 +00:00
var extension1 = undefined;
var extension2 = undefined;
var length = Math.max(typedField1.length, typedField2.length);
2016-03-30 18:39:59 +00:00
for (var i = 0; i < length; i++) {
var val1 = typedField1[i];
var val2 = typedField2[i];
2016-03-30 18:39:59 +00:00
if (val1 && (val1.constructor == Object)) {
goog.asserts.assert(extension1 === undefined);
goog.asserts.assert(i === typedField1.length - 1);
2016-03-30 18:39:59 +00:00
extension1 = val1;
val1 = undefined;
}
2016-03-30 18:39:59 +00:00
if (val2 && (val2.constructor == Object)) {
goog.asserts.assert(extension2 === undefined);
goog.asserts.assert(i === typedField2.length - 1);
2016-03-30 18:39:59 +00:00
extension2 = val2;
val2 = undefined;
}
2016-03-30 18:39:59 +00:00
if (!jspb.Message.compareFields(val1, val2)) {
return false;
}
}
2016-03-30 18:39:59 +00:00
if (extension1 || extension2) {
extension1 = extension1 || {};
extension2 = extension2 || {};
return jspb.Message.compareExtensions(extension1, extension2);
}
2016-03-30 18:39:59 +00:00
return true;
}
2016-03-30 18:39:59 +00:00
// If they're both plain Objects (i.e. extensions), compare them as
// extensions.
if (field1.constructor === Object) {
return jspb.Message.compareExtensions(field1, field2);
}
throw new Error('Invalid type in JSPB array');
};
/**
2016-09-19 20:45:07 +00:00
* Templated, type-safe cloneMessage definition.
* @return {THIS}
* @this {THIS}
* @template THIS
*/
jspb.Message.prototype.cloneMessage = function() {
return jspb.Message.cloneMessage(/** @type {!jspb.Message} */ (this));
};
/**
* Alias clone to cloneMessage. goog.object.unsafeClone uses clone to
* efficiently copy objects. Without this alias, copying jspb messages comes
* with a large performance penalty.
* @return {THIS}
* @this {THIS}
* @template THIS
*/
jspb.Message.prototype.clone = function() {
return jspb.Message.cloneMessage(/** @type {!jspb.Message} */ (this));
};
/**
* Static clone function. NOTE: A type-safe method called "cloneMessage"
* exists
* on each generated JsPb class. Do not call this function directly.
* @param {!jspb.Message} msg A message to clone.
* @return {!jspb.Message} A deep clone of the given message.
*/
jspb.Message.clone = function(msg) {
// Although we could include the wrappers, we leave them out here.
return jspb.Message.cloneMessage(msg);
};
/**
* @param {!jspb.Message} msg A message to clone.
* @return {!jspb.Message} A deep clone of the given message.
* @protected
*/
jspb.Message.cloneMessage = function(msg) {
// Although we could include the wrappers, we leave them out here.
return new msg.constructor(jspb.Message.clone_(msg.toArray()));
};
/**
* Takes 2 messages of the same type and copies the contents of the first
* message into the second. After this the 2 messages will equals in terms of
* value semantics but share no state. All data in the destination message will
* be overridden.
*
* @param {MESSAGE} fromMessage Message that will be copied into toMessage.
* @param {MESSAGE} toMessage Message which will receive a copy of fromMessage
* as its contents.
* @template MESSAGE
*/
jspb.Message.copyInto = function(fromMessage, toMessage) {
goog.asserts.assertInstanceof(fromMessage, jspb.Message);
goog.asserts.assertInstanceof(toMessage, jspb.Message);
goog.asserts.assert(fromMessage.constructor == toMessage.constructor,
'Copy source and target message should have the same type.');
var copyOfFrom = jspb.Message.clone(fromMessage);
var to = toMessage.toArray();
var from = copyOfFrom.toArray();
// Empty destination in case it has more values at the end of the array.
to.length = 0;
// and then copy everything from the new to the existing message.
for (var i = 0; i < from.length; i++) {
to[i] = from[i];
}
// This is either null or empty for a fresh copy.
toMessage.wrappers_ = copyOfFrom.wrappers_;
// Just a reference into the shared array.
toMessage.extensionObject_ = copyOfFrom.extensionObject_;
};
/**
* Helper for cloning an internal JsPb object.
* @param {!Object} obj A JsPb object, eg, a field, to be cloned.
* @return {!Object} A clone of the input object.
* @private
*/
jspb.Message.clone_ = function(obj) {
var o;
if (goog.isArray(obj)) {
// Allocate array of correct size.
var clonedArray = new Array(obj.length);
// Use array iteration where possible because it is faster than for-in.
for (var i = 0; i < obj.length; i++) {
o = obj[i];
if (o != null) {
// NOTE:redundant null check existing for NTI compatibility.
// see b/70515949
clonedArray[i] = (typeof o == 'object') ?
jspb.Message.clone_(goog.asserts.assert(o)) :
o;
}
}
return clonedArray;
}
if (jspb.Message.SUPPORTS_UINT8ARRAY_ && obj instanceof Uint8Array) {
return new Uint8Array(obj);
}
var clone = {};
for (var key in obj) {
o = obj[key];
if (o != null) {
// NOTE:redundant null check existing for NTI compatibility.
// see b/70515949
clone[key] = (typeof o == 'object') ?
jspb.Message.clone_(goog.asserts.assert(o)) :
o;
}
}
return clone;
};
/**
* Registers a JsPb message type id with its constructor.
* @param {string} id The id for this type of message.
* @param {Function} constructor The message constructor.
*/
jspb.Message.registerMessageType = function(id, constructor) {
jspb.Message.registry_[id] = constructor;
// This is needed so we can later access messageId directly on the contructor,
// otherwise it is not available due to 'property collapsing' by the compiler.
/**
* @suppress {strictMissingProperties} messageId is not defined on Function
*/
constructor.messageId = id;
};
/**
* The registry of message ids to message constructors.
* @private
*/
jspb.Message.registry_ = {};
/**
* The extensions registered on MessageSet. This is a map of extension
* field number to field info object. This should be considered as a
* private API.
*
* This is similar to [jspb class name].extensions object for
* non-MessageSet. We special case MessageSet so that we do not need
* to goog.require MessageSet from classes that extends MessageSet.
*
* @type {!Object<number, jspb.ExtensionFieldInfo>}
*/
jspb.Message.messageSetExtensions = {};
/**
* @type {!Object<number, jspb.ExtensionFieldBinaryInfo>}
*/
2016-09-19 20:45:07 +00:00
jspb.Message.messageSetExtensionsBinary = {};