Chiebot-Mirror
/
protobuf
mirror of https://github.com/protocolbuffers/protobuf.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

JavaScript: move extension binary info to separate struct.

Browse Source
pull/1802/head
Josh Haberman 8 years ago
parent 923eae8b16
commit 7429b91eda
3 changed files with 85 additions and 38 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      js/commonjs/export.js
  2. 71
      js/message.js
  3. 50
      src/google/protobuf/compiler/js/js_generator.cc

2
js/commonjs/export.js
Unescape View File

@ -9,12 +9,14 @@ goog.require('goog.object');
goog.require('jspb.BinaryReader'); goog.require('jspb.BinaryReader');
goog.require('jspb.BinaryWriter'); goog.require('jspb.BinaryWriter');
goog.require('jspb.ExtensionFieldInfo'); goog.require('jspb.ExtensionFieldInfo');
goog.require('jspb.ExtensionFieldBinaryInfo');
goog.require('jspb.Message'); goog.require('jspb.Message');
exports.Message = jspb.Message; exports.Message = jspb.Message;
exports.BinaryReader = jspb.BinaryReader; exports.BinaryReader = jspb.BinaryReader;
exports.BinaryWriter = jspb.BinaryWriter; exports.BinaryWriter = jspb.BinaryWriter;
exports.ExtensionFieldInfo = jspb.ExtensionFieldInfo; exports.ExtensionFieldInfo = jspb.ExtensionFieldInfo;
exports.ExtensionFieldBinaryInfo = jspb.ExtensionFieldBinaryInfo;
// These are used by generated code but should not be used directly by clients. // These are used by generated code but should not be used directly by clients.
exports.exportSymbol = goog.exportSymbol; exports.exportSymbol = goog.exportSymbol;

71
js/message.js
Unescape View File

@ -35,6 +35,7 @@
*/ */
goog.provide('jspb.ExtensionFieldInfo'); goog.provide('jspb.ExtensionFieldInfo');
goog.provide('jspb.ExtensionFieldBinaryInfo');
goog.provide('jspb.Message'); goog.provide('jspb.Message');
goog.require('goog.array'); goog.require('goog.array');
@ -84,19 +85,12 @@ goog.forwardDeclare('xid.String');
* @param {?function(new: jspb.Message, Array=)} ctor * @param {?function(new: jspb.Message, Array=)} ctor
* @param {?function((boolean|undefined),!jspb.Message):!Object} toObjectFn * @param {?function((boolean|undefined),!jspb.Message):!Object} toObjectFn
* @param {number} isRepeated * @param {number} isRepeated
* @param {?function(number,?)=} opt_binaryReaderFn
* @param {?function(number,?)|function(number,?,?,?,?,?)=} opt_binaryWriterFn
* @param {?function(?,?)=} opt_binaryMessageSerializeFn
* @param {?function(?,?)=} opt_binaryMessageDeserializeFn
* @param {?boolean=} opt_isPacked
* @constructor * @constructor
* @struct * @struct
* @template T * @template T
*/ */
jspb.ExtensionFieldInfo = function(fieldNumber, fieldName, ctor, toObjectFn, jspb.ExtensionFieldInfo = function(fieldNumber, fieldName, ctor, toObjectFn,
isRepeated, opt_binaryReaderFn, opt_binaryWriterFn, isRepeated) {
opt_binaryMessageSerializeFn, opt_binaryMessageDeserializeFn,
opt_isPacked) {
/** @const */ /** @const */
this.fieldIndex = fieldNumber; this.fieldIndex = fieldNumber;
/** @const */ /** @const */
@ -106,20 +100,37 @@ jspb.ExtensionFieldInfo = function(fieldNumber, fieldName, ctor, toObjectFn,
/** @const */ /** @const */
this.toObjectFn = toObjectFn; this.toObjectFn = toObjectFn;
/** @const */ /** @const */
this.binaryReaderFn = opt_binaryReaderFn; this.isRepeated = isRepeated;
};
/**
* Stores binary-related information for a single extension field.
* @param {!jspb.ExtensionFieldInfo<T>} fieldInfo
* @param {?function(number,?)=} binaryReaderFn
* @param {?function(number,?)|function(number,?,?,?,?,?)=} binaryWriterFn
* @param {?function(?,?)=} opt_binaryMessageSerializeFn
* @param {?function(?,?)=} opt_binaryMessageDeserializeFn
* @param {?boolean=} opt_isPacked
* @constructor
* @struct
* @template T
*/
jspb.ExtensionFieldBinaryInfo = function(fieldInfo, binaryReaderFn, binaryWriterFn,
binaryMessageSerializeFn, binaryMessageDeserializeFn, isPacked) {
/** @const */ /** @const */
this.binaryWriterFn = opt_binaryWriterFn; this.fieldInfo = fieldInfo;
/** @const */ /** @const */
this.binaryMessageSerializeFn = opt_binaryMessageSerializeFn; this.binaryReaderFn = binaryReaderFn;
/** @const */ /** @const */
this.binaryMessageDeserializeFn = opt_binaryMessageDeserializeFn; this.binaryWriterFn = binaryWriterFn;
/** @const */ /** @const */
this.isRepeated = isRepeated; this.binaryMessageSerializeFn = binaryMessageSerializeFn;
/** @const */ /** @const */
this.isPacked = opt_isPacked; this.binaryMessageDeserializeFn = binaryMessageDeserializeFn;
/** @const */
this.isPacked = isPacked;
}; };
/** /**
* @return {boolean} Does this field represent a sub Message? * @return {boolean} Does this field represent a sub Message?
*/ */
@ -491,11 +502,13 @@ jspb.Message.toObjectExtension = function(proto, obj, extensions,
jspb.Message.serializeBinaryExtensions = function(proto, writer, extensions, jspb.Message.serializeBinaryExtensions = function(proto, writer, extensions,
getExtensionFn) { getExtensionFn) {
for (var fieldNumber in extensions) { for (var fieldNumber in extensions) {
var fieldInfo = extensions[fieldNumber]; var binaryFieldInfo = extensions[fieldNumber];
var fieldInfo = binaryFieldInfo.fieldInfo;
// The old codegen doesn't add the extra fields to ExtensionFieldInfo, so we // 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 // need to gracefully error-out here rather than produce a null dereference
// below. // below.
if (!fieldInfo.binaryWriterFn) { if (!binaryFieldInfo.binaryWriterFn) {
throw new Error('Message extension present that was generated ' + throw new Error('Message extension present that was generated ' +
'without binary serialization support'); 'without binary serialization support');
} }
@ -508,16 +521,17 @@ jspb.Message.serializeBinaryExtensions = function(proto, writer, extensions,
// message may require binary support, so we can *only* catch this error // message may require binary support, so we can *only* catch this error
// here, at runtime (and this decoupled codegen is the whole point of // here, at runtime (and this decoupled codegen is the whole point of
// extensions!). // extensions!).
if (fieldInfo.binaryMessageSerializeFn) { if (binaryFieldInfo.binaryMessageSerializeFn) {
fieldInfo.binaryWriterFn.call(writer, fieldInfo.fieldIndex, binaryFieldInfo.binaryWriterFn.call(writer, fieldInfo.fieldIndex,
value, fieldInfo.binaryMessageSerializeFn); value, binaryFieldInfo.binaryMessageSerializeFn);
} else { } else {
throw new Error('Message extension present holding submessage ' + throw new Error('Message extension present holding submessage ' +
'without binary support enabled, and message is ' + 'without binary support enabled, and message is ' +
'being serialized to binary format'); 'being serialized to binary format');
} }
} else { } else {
fieldInfo.binaryWriterFn.call(writer, fieldInfo.fieldIndex, value); binaryFieldInfo.binaryWriterFn.call(
writer, fieldInfo.fieldIndex, value);
} }
} }
} }
@ -535,12 +549,13 @@ jspb.Message.serializeBinaryExtensions = function(proto, writer, extensions,
*/ */
jspb.Message.readBinaryExtension = function(msg, reader, extensions, jspb.Message.readBinaryExtension = function(msg, reader, extensions,
getExtensionFn, setExtensionFn) { getExtensionFn, setExtensionFn) {
var fieldInfo = extensions[reader.getFieldNumber()]; var binaryFieldInfo = extensions[reader.getFieldNumber()];
if (!fieldInfo) { var fieldInfo = binaryFieldInfo.fieldInfo;
if (!binaryFieldInfo) {
reader.skipField(); reader.skipField();
return; return;
} }
if (!fieldInfo.binaryReaderFn) { if (!binaryFieldInfo.binaryReaderFn) {
throw new Error('Deserializing extension whose generated code does not ' + throw new Error('Deserializing extension whose generated code does not ' +
'support binary format'); 'support binary format');
} }
@ -548,14 +563,14 @@ jspb.Message.readBinaryExtension = function(msg, reader, extensions,
var value; var value;
if (fieldInfo.isMessageType()) { if (fieldInfo.isMessageType()) {
value = new fieldInfo.ctor(); value = new fieldInfo.ctor();
fieldInfo.binaryReaderFn.call( binaryFieldInfo.binaryReaderFn.call(
reader, value, fieldInfo.binaryMessageDeserializeFn); reader, value, binaryFieldInfo.binaryMessageDeserializeFn);
} else { } else {
// All other types. // All other types.
value = fieldInfo.binaryReaderFn.call(reader); value = binaryFieldInfo.binaryReaderFn.call(reader);
} }
if (fieldInfo.isRepeated && !fieldInfo.isPacked) { if (fieldInfo.isRepeated && !binaryFieldInfo.isPacked) {
var currentList = getExtensionFn.call(msg, fieldInfo); var currentList = getExtensionFn.call(msg, fieldInfo);
if (!currentList) { if (!currentList) {
setExtensionFn.call(msg, fieldInfo, [value]); setExtensionFn.call(msg, fieldInfo, [value]);

50
src/google/protobuf/compiler/js/js_generator.cc
Unescape View File

@ -2524,6 +2524,29 @@ void Generator::GenerateClassExtensionFieldInfo(const GeneratorOptions& options,
"$class$.extensions = {};\n" "$class$.extensions = {};\n"
"\n", "\n",
"class", GetPath(options, desc)); "class", GetPath(options, desc));
if (options.binary) {
printer->Print(
"\n"
"/**\n"
" * The extensions registered with this message class. This is a "
"map of\n"
" * extension field number to fieldInfo object.\n"
" *\n"
" * For example:\n"
" * { 123: {fieldIndex: 123, fieldName: {my_field_name: 0}, "
"ctor: proto.example.MyMessage} }\n"
" *\n"
" * fieldName contains the JsCompiler renamed field name property "
"so that it\n"
" * works in OPTIMIZED mode.\n"
" *\n"
" * @type {!Object.<number, jspb.ExtensionFieldInfo>}\n"
" */\n"
"$class$.extensionsBinary = {};\n"
"\n",
"class", GetPath(options, desc));
}
} }
} }
@ -2571,7 +2594,7 @@ void Generator::GenerateClassDeserializeBinary(const GeneratorOptions& options,
" default:\n"); " default:\n");
if (IsExtendable(desc)) { if (IsExtendable(desc)) {
printer->Print( printer->Print(
" jspb.Message.readBinaryExtension(msg, reader, $extobj$,\n" " jspb.Message.readBinaryExtension(msg, reader, $extobj$Binary,\n"
" $class$.prototype.getExtension,\n" " $class$.prototype.getExtension,\n"
" $class$.prototype.setExtension);\n" " $class$.prototype.setExtension);\n"
" break;\n", " break;\n",
@ -2705,8 +2728,8 @@ void Generator::GenerateClassSerializeBinary(const GeneratorOptions& options,
if (IsExtendable(desc)) { if (IsExtendable(desc)) {
printer->Print( printer->Print(
" jspb.Message.serializeBinaryExtensions(this, writer, $extobj$,\n" " jspb.Message.serializeBinaryExtensions(this, writer,\n"
" $class$.prototype.getExtension);\n", " $extobj$Binary, $class$.prototype.getExtension);\n",
"extobj", JSExtensionsObjectName(options, desc->file(), desc), "extobj", JSExtensionsObjectName(options, desc->file(), desc),
"class", GetPath(options, desc)); "class", GetPath(options, desc));
} }
@ -2874,7 +2897,7 @@ void Generator::GenerateExtension(const GeneratorOptions& options,
" /** @type {?function((boolean|undefined),!jspb.Message=): " " /** @type {?function((boolean|undefined),!jspb.Message=): "
"!Object} */ (\n" "!Object} */ (\n"
" $toObject$),\n" " $toObject$),\n"
" $repeated$", " $repeated$);\n",
"index", SimpleItoa(field->number()), "index", SimpleItoa(field->number()),
"name", JSObjectFieldName(options, field), "name", JSObjectFieldName(options, field),
"ctor", (field->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE ? "ctor", (field->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE ?
@ -2886,12 +2909,18 @@ void Generator::GenerateExtension(const GeneratorOptions& options,
if (options.binary) { if (options.binary) {
printer->Print( printer->Print(
",\n" "\n"
"$extendName$Binary[$index$] = new jspb.ExtensionFieldBinaryInfo(\n"
" $class$.$name$,\n"
" $binaryReaderFn$,\n" " $binaryReaderFn$,\n"
" $binaryWriterFn$,\n" " $binaryWriterFn$,\n"
" $binaryMessageSerializeFn$,\n" " $binaryMessageSerializeFn$,\n"
" $binaryMessageDeserializeFn$,\n" " $binaryMessageDeserializeFn$,\n",
" $isPacked$);\n", "extendName", JSExtensionsObjectName(options, field->file(),
field->containing_type()),
"index", SimpleItoa(field->number()),
"class", extension_scope,
"name", JSObjectFieldName(options, field),
"binaryReaderFn", JSBinaryReaderMethodName(options, field), "binaryReaderFn", JSBinaryReaderMethodName(options, field),
"binaryWriterFn", JSBinaryWriterMethodName(options, field), "binaryWriterFn", JSBinaryWriterMethodName(options, field),
"binaryMessageSerializeFn", "binaryMessageSerializeFn",
@ -2901,10 +2930,11 @@ void Generator::GenerateExtension(const GeneratorOptions& options,
"binaryMessageDeserializeFn", "binaryMessageDeserializeFn",
(field->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE) ? (field->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE) ?
(SubmessageTypeRef(options, field) + (SubmessageTypeRef(options, field) +
".deserializeBinaryFromReader") : "null", ".deserializeBinaryFromReader") : "null");
printer->Print(
" $isPacked$);\n",
"isPacked", (field->is_packed() ? "true" : "false")); "isPacked", (field->is_packed() ? "true" : "false"));
} else {
printer->Print(");\n");
} }
printer->Print( printer->Print(

Write Preview
Loading…
Cancel
Save