protobufjs 3.6.0 → 3.8.2

package/src/ProtoBuf/Builder.js

@@ -9,16 +9,17 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
      * Constructs a new Builder.
      * @exports ProtoBuf.Builder
      * @class Provides the functionality to build protocol messages.
+     * @param {Object.<string,*>=} options Options
      * @constructor
      */
-    var Builder = function() {
+    var Builder = function(options) {
 
         /**
          * Namespace.
          * @type {ProtoBuf.Reflect.Namespace}
          * @expose
          */
-        this.ns = new Reflect.Namespace(null, ""); // Global namespace
+        this.ns = new Reflect.Namespace(this, null, ""); // Global namespace
 
         /**
          * Namespace pointer.
@@ -54,13 +55,26 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
          * @expose
          */
         this.importRoot = null;
+
+        /**
+         * Options.
+         * @type {!Object.<string, *>}
+         * @expose
+         */
+        this.options = options || {};
     };
 
+    /**
+     * @alias ProtoBuf.Builder.prototype
+     * @inner
+     */
+    var BuilderPrototype = Builder.prototype;
+
     /**
      * Resets the pointer to the root namespace.
      * @expose
      */
-    Builder.prototype.reset = function() {
+    BuilderPrototype.reset = function() {
         this.ptr = this.ns;
     };
 
@@ -72,7 +86,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
      * @throws {Error} If the package name is invalid
      * @expose
      */
-    Builder.prototype.define = function(pkg, options) {
+    BuilderPrototype.define = function(pkg, options) {
         if (typeof pkg !== 'string' || !Lang.TYPEREF.test(pkg))
             throw Error("Illegal package: "+pkg);
         var part = pkg.split("."), i;
@@ -81,7 +95,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
                 throw Error("Illegal package: "+part[i]);
         for (i=0; i<part.length; i++) {
             if (this.ptr.getChild(part[i]) === null) // Keep existing namespace
-                this.ptr.addChild(new Reflect.Namespace(this.ptr, part[i], options));
+                this.ptr.addChild(new Reflect.Namespace(this, this.ptr, part[i], options));
             this.ptr = this.ptr.getChild(part[i]);
         }
         return this;
@@ -195,7 +209,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
      * @throws {Error} If a message definition is invalid
      * @expose
      */
-    Builder.prototype.create = function(defs) {
+    BuilderPrototype.create = function(defs) {
         if (!defs)
             return this; // Nothing to create
         if (!ProtoBuf.Util.isArray(defs))
@@ -204,35 +218,51 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
             return this;
         
         // It's quite hard to keep track of scopes and memory here, so let's do this iteratively.
-        var stack = [], def, obj, subObj, i, j;
+        var stack = [];
         stack.push(defs); // One level [a, b, c]
         while (stack.length > 0) {
             defs = stack.pop();
             if (ProtoBuf.Util.isArray(defs)) { // Stack always contains entire namespaces
                 while (defs.length > 0) {
-                    def = defs.shift(); // Namespace always contains an array of messages, enums and services
+                    var def = defs.shift(); // Namespace always contains an array of messages, enums and services
                     if (Builder.isValidMessage(def)) {
-                        obj = new Reflect.Message(this.ptr, def["name"], def["options"], def["isGroup"]);
+                        var obj = new Reflect.Message(this, this.ptr, def["name"], def["options"], def["isGroup"]);
+                        // Create OneOfs
+                        var oneofs = {};
+                        if (def["oneofs"]) {
+                            var keys = Object.keys(def["oneofs"]);
+                            for (var i=0, k=keys.length; i<k; ++i)
+                                obj.addChild(oneofs[keys[i]] = new Reflect.Message.OneOf(this, obj, keys[i]));
+                        }
                         // Create fields
                         if (def["fields"] && def["fields"].length > 0) {
-                            for (i=0; i<def["fields"].length; i++) { // i=Fields
-                                if (obj.getChild(def['fields'][i]['id']) !== null)
-                                    throw Error("Duplicate field id in message "+obj.name+": "+def['fields'][i]['id']);
-                                if (def["fields"][i]["options"]) {
-                                    subObj = Object.keys(def["fields"][i]["options"]);
-                                    for (j=0; j<subObj.length; j++) { // j=Option names
-                                        if (typeof subObj[j] !== 'string')
-                                            throw Error("Illegal field option name in message "+obj.name+"#"+def["fields"][i]["name"]+": "+subObj[j]);
-                                        if (typeof def["fields"][i]["options"][subObj[j]] !== 'string' && typeof def["fields"][i]["options"][subObj[j]] !== 'number' && typeof def["fields"][i]["options"][subObj[j]] !== 'boolean')
-                                            throw Error("Illegal field option value in message "+obj.name+"#"+def["fields"][i]["name"]+"#"+subObj[j]+": "+def["fields"][i]["options"][subObj[j]]);
+                            for (i=0, k=def["fields"].length; i<k; ++i) { // i:k=Fields
+                                var fld = def['fields'][i];
+                                if (obj.getChild(fld['id']) !== null)
+                                    throw Error("Duplicate field id in message "+obj.name+": "+fld['id']);
+                                if (fld["options"]) {
+                                    var opts = Object.keys(fld["options"]);
+                                    for (var j= 0,l=opts.length; j<l; ++j) { // j:l=Option names
+                                        if (typeof opts[j] !== 'string')
+                                            throw Error("Illegal field option name in message "+obj.name+"#"+fld["name"]+": "+opts[j]);
+                                        if (typeof fld["options"][opts[j]] !== 'string' && typeof fld["options"][opts[j]] !== 'number' && typeof fld["options"][opts[j]] !== 'boolean')
+                                            throw Error("Illegal field option value in message "+obj.name+"#"+fld["name"]+"#"+opts[j]+": "+fld["options"][opts[j]]);
                                     }
-                                    subObj = null;
                                 }
-                                obj.addChild(new Reflect.Message.Field(obj, def["fields"][i]["rule"], def["fields"][i]["type"], def["fields"][i]["name"], def["fields"][i]["id"], def["fields"][i]["options"]));
+                                var oneof = null;
+                                if (typeof fld["oneof"] === 'string') {
+                                    oneof = oneofs[fld["oneof"]];
+                                    if (typeof oneof === 'undefined')
+                                        throw Error("Illegal oneof in message "+obj.name+"#"+fld["name"]+": "+fld["oneof"]);
+                                }
+                                fld = new Reflect.Message.Field(this, obj, fld["rule"], fld["type"], fld["name"], fld["id"], fld["options"], oneof);
+                                if (oneof)
+                                    oneof.fields.push(fld);
+                                obj.addChild(fld);
                             }
                         }
                         // Push enums and messages to stack
-                        subObj = [];
+                        var subObj = [];
                         if (typeof def["enums"] !== 'undefined' && def['enums'].length > 0)
                             for (i=0; i<def["enums"].length; i++)
                                 subObj.push(def["enums"][i]);
@@ -259,16 +289,16 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
                         subObj = null;
                         obj = null;
                     } else if (Builder.isValidEnum(def)) {
-                        obj = new Reflect.Enum(this.ptr, def["name"], def["options"]);
+                        obj = new Reflect.Enum(this, this.ptr, def["name"], def["options"]);
                         for (i=0; i<def["values"].length; i++)
-                            obj.addChild(new Reflect.Enum.Value(obj, def["values"][i]["name"], def["values"][i]["id"]));
+                            obj.addChild(new Reflect.Enum.Value(this, obj, def["values"][i]["name"], def["values"][i]["id"]));
                         this.ptr.addChild(obj);
                         obj = null;
                     } else if (Builder.isValidService(def)) {
-                        obj = new Reflect.Service(this.ptr, def["name"], def["options"]);
+                        obj = new Reflect.Service(this, this.ptr, def["name"], def["options"]);
                         for (i in def["rpc"])
                             if (def["rpc"].hasOwnProperty(i))
-                                obj.addChild(new Reflect.Service.RPCMethod(obj, i, def["rpc"][i]["request"], def["rpc"][i]["response"], def["rpc"][i]["options"]));
+                                obj.addChild(new Reflect.Service.RPCMethod(this, obj, i, def["rpc"][i]["request"], def["rpc"][i]["response"], def["rpc"][i]["options"]));
                         this.ptr.addChild(obj);
                         obj = null;
                     } else if (Builder.isValidExtend(def)) {
@@ -279,10 +309,16 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
                                     throw Error("Duplicate extended field id in message "+obj.name+": "+def['fields'][i]['id']);
                                 if (def['fields'][i]['id'] < obj.extensions[0] || def['fields'][i]['id'] > obj.extensions[1])
                                     throw Error("Illegal extended field id in message "+obj.name+": "+def['fields'][i]['id']+" ("+obj.extensions.join(' to ')+" expected)");
+                                // Convert extension field names to camel case notation if the override is set
+                                var name = def["fields"][i]["name"];
+                                if (this.options['convertFieldsToCamelCase'])
+                                    name = Reflect.Message.Field._toCamelCase(def["fields"][i]["name"]);
                                 // see #161: Extensions use their fully qualified name as their runtime key and...
-                                var fld = new Reflect.Message.ExtensionField(obj, def["fields"][i]["rule"], def["fields"][i]["type"], this.ptr.fqn()+'.'+def["fields"][i]["name"], def["fields"][i]["id"], def["fields"][i]["options"]);
-                                // ...are added on top of the current namespace as an extension which is used for resolving their type later on
-                                var ext = new Reflect.Extension(this.ptr, def["fields"][i]["name"], fld);
+                                fld = new Reflect.Message.ExtensionField(this, obj, def["fields"][i]["rule"], def["fields"][i]["type"], this.ptr.fqn()+'.'+name, def["fields"][i]["id"], def["fields"][i]["options"]);
+                                // ...are added on top of the current namespace as an extension which is used for
+                                // resolving their type later on (the extension always keeps the original name to
+                                // prevent naming collisions)
+                                var ext = new Reflect.Extension(this, this.ptr, def["fields"][i]["name"], fld);
                                 fld.extension = ext;
                                 this.ptr.addChild(ext);
                                 obj.addChild(fld);
@@ -312,7 +348,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
      * @throws {Error} If the definition or file cannot be imported
      * @expose
      */
-    Builder.prototype["import"] = function(json, filename) {
+    BuilderPrototype["import"] = function(json, filename) {
         if (typeof filename === 'string') {
             if (ProtoBuf.Util.IS_NODE)
                 filename = require("path")['resolve'](filename);
@@ -446,7 +482,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
      * @throws {Error} If a type cannot be resolved
      * @expose
      */
-    Builder.prototype.resolveAll = function() {
+    BuilderPrototype.resolveAll = function() {
         // Resolve all reflected objects
         var res;
         if (this.ptr == null || typeof this.ptr.type === 'object')
@@ -489,9 +525,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
                 // Should not happen as nothing else is implemented
                 throw Error("Illegal service type in "+this.ptr.toString(true));
             }
-        } else if (this.ptr instanceof ProtoBuf.Reflect.Extension) {
-            // There are no runtime counterparts to extensions
-        } else
+        } else if (!(this.ptr instanceof ProtoBuf.Reflect.Message.OneOf) && !(this.ptr instanceof ProtoBuf.Reflect.Extension))
             throw Error("Illegal object in namespace: "+typeof(this.ptr)+":"+this.ptr);
         this.reset();
     };
@@ -504,7 +538,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
      * @throws {Error} If a type could not be resolved
      * @expose
      */
-    Builder.prototype.build = function(path) {
+    BuilderPrototype.build = function(path) {
         this.reset();
         if (!this.resolved)
             this.resolveAll(),
@@ -533,7 +567,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
      * @param {string=} path Specifies what to return. If omitted, the entire namespace wiil be returned.
      * @return {ProtoBuf.Reflect.T} Reflection descriptor or `null` if not found
      */
-    Builder.prototype.lookup = function(path) {
+    BuilderPrototype.lookup = function(path) {
         return path ? this.ns.resolve(path) : this.ns;
     };
 
@@ -542,7 +576,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
      * @return {string} String representation as of "Builder"
      * @expose
      */
-    Builder.prototype.toString = function() {
+    BuilderPrototype.toString = function() {
         return "Builder";
     };