New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

how can i get the message define name from .proto? #693

Closed
jarvanxing opened this Issue Mar 2, 2017 · 4 comments

Comments

Projects
None yet
2 participants
@jarvanxing

jarvanxing commented Mar 2, 2017

protobuf.js version: <6.6.4>

i want to collect all the message names in a map, like below:

syntax = "proto3";

import "target.proto";
import "image.proto";
import ...

package protobuf;

message AcceptVoipRequest {
  Target target = 1; // 目标
}

// all my .proto files just like above

function getMessageName(proto) {
   let name
   // how to do this?
   // here name = 'AcceptVoipRequest'
   return name
}

protoNames.forEach(name => {
  let filePath = path.join(protoDir, name)
  let proto = ProtoBuf.loadSync(filePath)
  map[getMessageName(proto)] = proto
})
@dcodeIO

This comment has been minimized.

Owner

dcodeIO commented Mar 2, 2017

Ideally, you'd just traverse through the root instance by calling a function with your logic for each message type within:

function traverseTypes(current, fn) {
  if (current instanceof protobuf.Type)
    fn(current);
  if (current.nestedArray)
    current.nestedArray.forEach(function(nested) {
      traverseTypes(nested, fn);
    });
}

Example:

var root = protobuf.loadSync(...);

traverseTypes(root, function(type) {
  console.log(type.fullName);
});

See also: API of protobuf.Type

Also created an example.

@dcodeIO dcodeIO added the question label Mar 2, 2017

@jarvanxing

This comment has been minimized.

jarvanxing commented Mar 6, 2017

@dcodeIO that's not what i really want, your code above will display all the message names that a .proto file have(or imports). but i only want display the single name without any imports(for example i only want display the name: 'AcceptVoipRequest').

@dcodeIO

This comment has been minimized.

Owner

dcodeIO commented Mar 6, 2017

A Root instance always contains all types of messages loaded into it. To find a specific message within a specific file, you'd either have to examine that exact file, i.e. using a regular expression

var source = ...;
var re = /\bmessage\s+(\w+) /g;
var match;
while (match = re.exec(source)) {
   console.log(match[1]);
}

or to annotate the messages you'd like to expose in some way understood by reflection, so you can filter.

message AcceptVoipRequest {
  option someOption = true;
  Target target = 1; // 目标
}
traverseTypes(root, function(type) {
  if (type.options && type.options.someOption)
    console.log(type.fullName);
});

Additionally, reflection objects (messages, enums, services etc.) also have a filename property that you could use.

traverseTypes(root, function(type) {
  if (/\bAcceptVoipRequest\.proto$/.test(type.filename))
    console.log(type.fullName);
});

Likewise, all loaded files are present within Root#files (a string array).

See also: Updated example

dcodeIO added a commit that referenced this issue Mar 6, 2017

@jarvanxing

This comment has been minimized.

jarvanxing commented Mar 7, 2017

@dcodeIO thanks a lot for your patience and help. Examine the exact file or the filename is fit for me. I finally solved this problem by examine the filename and fllow some rules of convention。

@jarvanxing jarvanxing closed this Mar 7, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment