xref: /third_party/protobuf/js/message.js

32  * @fileoverview Definition of jspb.Message.
39 goog.provide('jspb.Message');
83  * @param {?function(new: jspb.Message, Array=)} ctor
84  * @param {?function((boolean|undefined),!jspb.Message):!Object} toObjectFn
134  * @return {boolean} Does this field represent a sub Message?
155  *     WARNING - Property serializeBinary never defined on jspb.Message
161 jspb.Message = function() {
173 jspb.Message.GENERATE_TO_OBJECT =
174     goog.define('jspb.Message.GENERATE_TO_OBJECT', true);
186 jspb.Message.GENERATE_FROM_OBJECT = goog.define(
187     'jspb.Message.GENERATE_FROM_OBJECT', !goog.DISALLOW_TEST_ONLY_CODE);
195 jspb.Message.GENERATE_TO_STRING =
196     goog.define('jspb.Message.GENERATE_TO_STRING', true);
204 jspb.Message.ASSUME_LOCAL_ARRAYS =
205     goog.define('jspb.Message.ASSUME_LOCAL_ARRAYS', false);
215 jspb.Message.SERIALIZE_EMPTY_TRAILING_FIELDS =
216     goog.define('jspb.Message.SERIALIZE_EMPTY_TRAILING_FIELDS', true);
224 jspb.Message.SUPPORTS_UINT8ARRAY_ = (typeof Uint8Array == 'function');
232 jspb.Message.prototype.array;
242 jspb.Message.prototype.wrappers_;
251 jspb.Message.prototype.extensionObject_;
260 jspb.Message.prototype.pivot_;
269 jspb.Message.prototype.messageId_;
278 jspb.Message.prototype.convertedPrimitiveFields_;
284 jspb.Message.prototype.repeatedFields;
293 jspb.Message.prototype.getJsPbMessageId = function() {
305 jspb.Message.prototype.arrayIndexOffset_;
311  * @param {!jspb.Message} msg Message for which we're calculating an index.
316 jspb.Message.getIndex_ = function(msg, fieldNumber) {
322 jspb.Message.hiddenES6Property_ = class {};
327  * @param {!jspb.Message} msg Message for which we're calculating an index.
332 jspb.Message.getFieldNumber_ = function(msg, index) {
338  * Initializes a JsPb Message.
339  * @param {!jspb.Message} msg The JsPb proto to modify.
352 jspb.Message.initialize = function(
364   jspb.Message.initPivotAndExtensionObject_(msg, suggestedPivot);
367   if (!jspb.Message.SERIALIZE_EMPTY_TRAILING_FIELDS) {
378         var index = jspb.Message.getIndex_(msg, fieldNumber);
380             msg.array[index] || jspb.Message.EMPTY_LIST_SENTINEL_;
382         jspb.Message.maybeInitEmptyExtensionObject_(msg);
384             jspb.Message.EMPTY_LIST_SENTINEL_;
393       jspb.Message.computeOneofCase(msg, opt_oneofFields[i]);
407 jspb.Message.EMPTY_LIST_SENTINEL_ = goog.DEBUG && Object.freeze ?
418 jspb.Message.isArray_ = function(o) {
419   return jspb.Message.ASSUME_LOCAL_ARRAYS ? o instanceof Array :
429 jspb.Message.isExtensionObject_ = function(o) {
437       !jspb.Message.isArray_(o) &&
438       !(jspb.Message.SUPPORTS_UINT8ARRAY_ && o instanceof Uint8Array));
448  * @param {!jspb.Message} msg The JsPb proto to modify.
452 jspb.Message.initPivotAndExtensionObject_ = function(msg, suggestedPivot) {
466     if (jspb.Message.isExtensionObject_(obj)) {
467       msg.pivot_ = jspb.Message.getFieldNumber_(msg, lastIndex);
477         suggestedPivot, jspb.Message.getFieldNumber_(msg, lastIndex + 1));
493  * @param {!jspb.Message} msg The JsPb proto to modify.
496 jspb.Message.maybeInitEmptyExtensionObject_ = function(msg) {
497   var pivotIndex = jspb.Message.getIndex_(msg, msg.pivot_);
517 jspb.Message.toObjectList = function(field, toObjectFn, opt_includeInstance) {
530  * @param {!jspb.Message} proto The proto whose extensions to convert.
539 jspb.Message.toObjectExtension = function(proto, obj, extensions,
554           obj[name] = jspb.Message.toObjectList(
555               /** @type {!Array<!jspb.Message>} */ (value),
559               opt_includeInstance, /** @type {!jspb.Message} */ (value));
569  * @param {!jspb.Message} proto The proto whose extensions to convert.
572  * @param {function(this:jspb.Message,!jspb.ExtensionFieldInfo) : *} getExtensionFn The proto
575 jspb.Message.serializeBinaryExtensions = function(proto, writer, extensions,
585       throw new Error('Message extension present that was generated ' +
601           throw new Error('Message extension present holding submessage ' +
617  * @param {!jspb.Message} msg A jspb proto.
620  * @param {function(this:jspb.Message,!jspb.ExtensionFieldInfo)} getExtensionFn
621  * @param {function(this:jspb.Message,!jspb.ExtensionFieldInfo, ?)} setExtensionFn
623 jspb.Message.readBinaryExtension = function(msg, reader, extensions,
661  * @param {!jspb.Message} msg A jspb proto.
667 jspb.Message.getField = function(msg, fieldNumber) {
669     var index = jspb.Message.getIndex_(msg, fieldNumber);
671     if (val === jspb.Message.EMPTY_LIST_SENTINEL_) {
680     if (val === jspb.Message.EMPTY_LIST_SENTINEL_) {
690  * @param {!jspb.Message} msg A jspb proto.
696 jspb.Message.getRepeatedField = function(msg, fieldNumber) {
697   return /** @type {!Array} */ (jspb.Message.getField(msg, fieldNumber));
703  * @param {!jspb.Message} msg A jspb proto.
708 jspb.Message.getOptionalFloatingPointField = function(msg, fieldNumber) {
709   var value = jspb.Message.getField(msg, fieldNumber);
717  * @param {!jspb.Message} msg A jspb proto.
722 jspb.Message.getBooleanField = function(msg, fieldNumber) {
723   var value = jspb.Message.getField(msg, fieldNumber);
731  * @param {!jspb.Message} msg A jspb proto.
736 jspb.Message.getRepeatedFloatingPointField = function(msg, fieldNumber) {
737   var values = jspb.Message.getRepeatedField(msg, fieldNumber);
754  * @param {!jspb.Message} msg A jspb proto.
759 jspb.Message.getRepeatedBooleanField = function(msg, fieldNumber) {
760   var values = jspb.Message.getRepeatedField(msg, fieldNumber);
780 jspb.Message.bytesAsB64 = function(value) {
784   if (jspb.Message.SUPPORTS_UINT8ARRAY_ && value instanceof Uint8Array) {
799 jspb.Message.bytesAsU8 = function(value) {
817 jspb.Message.bytesListAsB64 = function(value) {
818   jspb.Message.assertConsistentTypes_(value);
822   return goog.array.map(value, jspb.Message.bytesAsB64);
834 jspb.Message.bytesListAsU8 = function(value) {
835   jspb.Message.assertConsistentTypes_(value);
839   return goog.array.map(value, jspb.Message.bytesAsU8);
848 jspb.Message.assertConsistentTypes_ = function(array) {
866  * @param {!jspb.Message} msg A jspb proto.
872 jspb.Message.getFieldWithDefault = function(msg, fieldNumber, defaultValue) {
873   var value = jspb.Message.getField(msg, fieldNumber);
886  * @param {!jspb.Message} msg A jspb proto.
892 jspb.Message.getBooleanFieldWithDefault = function(
894   var value = jspb.Message.getBooleanField(msg, fieldNumber);
908  * @param {!jspb.Message} msg A jspb proto.
914 jspb.Message.getFloatingPointFieldWithDefault = function(
916   var value = jspb.Message.getOptionalFloatingPointField(msg, fieldNumber);
928  * @param {!jspb.Message} msg A jspb proto.
934 jspb.Message.getFieldProto3 = jspb.Message.getFieldWithDefault;
946  * @param {!jspb.Message} msg
953 jspb.Message.getMapField = function(msg, fieldNumber, noLazyCreate,
962   var arr = jspb.Message.getField(msg, fieldNumber);
969     jspb.Message.setField(msg, fieldNumber, arr);
986 jspb.Message.setField = function(msg, fieldNumber, value) {
988   goog.asserts.assertInstanceof(msg, jspb.Message);
990     msg.array[jspb.Message.getIndex_(msg, fieldNumber)] = value;
992     jspb.Message.maybeInitEmptyExtensionObject_(msg);
1008 jspb.Message.setProto3IntField = function(msg, fieldNumber, value) {
1009   return jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, 0);
1022 jspb.Message.setProto3FloatField = function(msg, fieldNumber, value) {
1023   return jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, 0.0);
1036 jspb.Message.setProto3BooleanField = function(msg, fieldNumber, value) {
1037   return jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, false);
1050 jspb.Message.setProto3StringField = function(msg, fieldNumber, value) {
1051   return jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, '');
1064 jspb.Message.setProto3BytesField = function(msg, fieldNumber, value) {
1065   return jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, '');
1078 jspb.Message.setProto3EnumField = function(msg, fieldNumber, value) {
1079   return jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, 0);
1093 jspb.Message.setProto3StringIntField = function(msg, fieldNumber, value) {
1094   return jspb.Message.setFieldIgnoringDefault_(msg, fieldNumber, value, '0');
1109 jspb.Message.setFieldIgnoringDefault_ = function(
1112   goog.asserts.assertInstanceof(msg, jspb.Message);
1114     jspb.Message.setField(msg, fieldNumber, value);
1116     msg.array[jspb.Message.getIndex_(msg, fieldNumber)] = null;
1118     jspb.Message.maybeInitEmptyExtensionObject_(msg);
1135 jspb.Message.addToRepeatedField = function(msg, fieldNumber, value, opt_index) {
1137   goog.asserts.assertInstanceof(msg, jspb.Message);
1138   var arr = jspb.Message.getRepeatedField(msg, fieldNumber);
1159 jspb.Message.setOneofField = function(msg, fieldNumber, oneof, value) {
1161   goog.asserts.assertInstanceof(msg, jspb.Message);
1162   var currentCase = jspb.Message.computeOneofCase(msg, oneof);
1167     jspb.Message.setField(msg, currentCase, undefined);
1169   return jspb.Message.setField(msg, fieldNumber, value);
1185  * @param {!jspb.Message} msg A jspb proto.
1190 jspb.Message.computeOneofCase = function(msg, oneof) {
1196     var value = jspb.Message.getField(msg, fieldNumber);
1200       jspb.Message.setField(msg, fieldNumber, undefined);
1205     // NB: We know the value is unique, so we can call jspb.Message.setField
1206     // directly instead of jpsb.Message.setOneofField. Also, setOneofField
1208     jspb.Message.setField(msg, oneofField, oneofValue);
1218  * @param {!jspb.Message} msg A jspb proto.
1219  * @param {function(new:jspb.Message, Array)} ctor Constructor for the field.
1222  * @return {jspb.Message} The field as a jspb proto.
1225 jspb.Message.getWrapperField = function(msg, ctor, fieldNumber, opt_required) {
1231     var data = /** @type {Array} */ (jspb.Message.getField(msg, fieldNumber));
1237   return /** @type {jspb.Message} */ (msg.wrappers_[fieldNumber]);
1243  * @param {!jspb.Message} msg A jspb proto.
1244  * @param {function(new:jspb.Message, Array)} ctor Constructor for the field.
1246  * @return {!Array<!jspb.Message>} The repeated field as an array of protos.
1249 jspb.Message.getRepeatedWrapperField = function(msg, ctor, fieldNumber) {
1250   jspb.Message.wrapRepeatedField_(msg, ctor, fieldNumber);
1252   if (val == jspb.Message.EMPTY_LIST_SENTINEL_) {
1255   return /** @type {!Array<!jspb.Message>} */ (val);
1262  * @param {!jspb.Message} msg A jspb proto.
1263  * @param {function(new:jspb.Message, ?Array)} ctor Constructor for the field.
1267 jspb.Message.wrapRepeatedField_ = function(msg, ctor, fieldNumber) {
1272     var data = jspb.Message.getRepeatedField(msg, fieldNumber);
1285  * @param {?jspb.Message|?jspb.Map|undefined} value A new value for this proto
1291 jspb.Message.setWrapperField = function(msg, fieldNumber, value) {
1293   goog.asserts.assertInstanceof(msg, jspb.Message);
1299   return jspb.Message.setField(msg, fieldNumber, data);
1309  * @param {jspb.Message|undefined} value A new value for this proto field.
1314 jspb.Message.setOneofWrapperField = function(msg, fieldNumber, oneof, value) {
1316   goog.asserts.assertInstanceof(msg, jspb.Message);
1322   return jspb.Message.setOneofField(msg, fieldNumber, oneof, data);
1330  * @param {Array<!jspb.Message>|undefined} value An array of protos.
1335 jspb.Message.setRepeatedWrapperField = function(msg, fieldNumber, value) {
1337   goog.asserts.assertInstanceof(msg, jspb.Message);
1346   return jspb.Message.setField(msg, fieldNumber, data);
1352  * @param {!jspb.Message} msg A jspb proto.
1372 jspb.Message.addToRepeatedWrapperField = function(
1374   jspb.Message.wrapRepeatedField_(msg, ctor, fieldNumber);
1380   var array = jspb.Message.getRepeatedField(msg, fieldNumber);
1409 jspb.Message.toMap = function(
1415             /** @type {!jspb.Message} */ (field[i])) : field[i];
1425 jspb.Message.prototype.syncMapFields_ = function() {
1459 jspb.Message.prototype.toArray = function() {
1466 if (jspb.Message.GENERATE_TO_STRING) {
1474 jspb.Message.prototype.toString = function() {
1487 jspb.Message.prototype.getExtension = function(fieldInfo) {
1526  * @param {jspb.Message|string|Uint8Array|number|boolean|Array?} value The value
1532 jspb.Message.prototype.setExtension = function(fieldInfo, value) {
1535   var self = /** @type {!jspb.Message} */ (this);
1539   jspb.Message.maybeInitEmptyExtensionObject_(self);
1546           /** @type {!Array<!jspb.Message>} */ (value), function(msg) {
1556           value ? /** @type {!jspb.Message} */ (value).toArray() : value;
1577  * @param {!jspb.Message} m1 The first message object.
1578  * @param {!jspb.Message} m2 The second message object.
1579  * @return {!jspb.Message} The difference returned as a proto message.
1586 jspb.Message.difference = function(m1, m2) {
1600     if (!jspb.Message.compareFields(arr1[i], arr2[i])) {
1610  * @param {jspb.Message|undefined} m1 The first message object.
1611  * @param {jspb.Message|undefined} m2 The second message object.
1615 jspb.Message.equals = function(m1, m2) {
1617       jspb.Message.compareFields(m1.toArray(), m2.toArray()));
1628 jspb.Message.compareExtensions = function(extension1, extension2) {
1640     if (!jspb.Message.compareFields(extension1[name], extension2[name])) {
1654 jspb.Message.compareFields = function(field1, field2) {
1676   if (jspb.Message.SUPPORTS_UINT8ARRAY_ && field1.constructor === Uint8Array) {
1713       if (!jspb.Message.compareFields(val1, val2)) {
1721       return jspb.Message.compareExtensions(extension1, extension2);
1730     return jspb.Message.compareExtensions(field1, field2);
1743 jspb.Message.prototype.cloneMessage = function() {
1744   return jspb.Message.cloneMessage(/** @type {!jspb.Message} */ (this));
1755 jspb.Message.prototype.clone = function() {
1756   return jspb.Message.cloneMessage(/** @type {!jspb.Message} */ (this));
1763  * @param {!jspb.Message} msg A message to clone.
1764  * @return {!jspb.Message} A deep clone of the given message.
1766 jspb.Message.clone = function(msg) {
1768   return jspb.Message.cloneMessage(msg);
1773  * @param {!jspb.Message} msg A message to clone.
1774  * @return {!jspb.Message} A deep clone of the given message.
1777 jspb.Message.cloneMessage = function(msg) {
1779   return new msg.constructor(jspb.Message.clone_(msg.toArray()));
1789  * @param {MESSAGE} fromMessage Message that will be copied into toMessage.
1790  * @param {MESSAGE} toMessage Message which will receive a copy of fromMessage
1794 jspb.Message.copyInto = function(fromMessage, toMessage) {
1795   goog.asserts.assertInstanceof(fromMessage, jspb.Message);
1796   goog.asserts.assertInstanceof(toMessage, jspb.Message);
1799   var copyOfFrom = jspb.Message.clone(fromMessage);
1824 jspb.Message.clone_ = function(obj) {
1836             jspb.Message.clone_(goog.asserts.assert(o)) :
1842   if (jspb.Message.SUPPORTS_UINT8ARRAY_ && obj instanceof Uint8Array) {
1852           jspb.Message.clone_(goog.asserts.assert(o)) :
1865 jspb.Message.registerMessageType = function(id, constructor) {
1884 jspb.Message.messageSetExtensions = {};
1889 jspb.Message.messageSetExtensionsBinary = {};

Indexes created Thu Nov 07 10:32:03 CST 2024