proto2rapidjson 1.1.4

Convert .proto file to header-only RapidJSON based c++ code

Proto2RapidJSON

简介

本工具旨在利用proto文件生成基于RapidJSON的JSON文件解析与序列化的C++工具。

• 本工具只会支持最基本的类proto语法，但保证其强类型属性；
• 本工具生成的C++代码只依赖RapidJSON与C++11 STL，如果需要使用nested namespace则需要C++20的支持；
• 本工具支持//注释。

本工具使用MIT协议。

基本格式

package test;

message B {
  bool isok;
}

message A {
  double x;
  int32 y;
  repeated B b;
}

对应的JSON文件（message A对应的）为

{
    "x": 1.24,
    "y": 123,
    "b": [
        {
            "isok": true
        },
        {
            "isok": false
        }
    ]
}

注：暂不允许可选属性，但允许额外的属性（不会被解析）。

生成的C++文件应该包含结构体与接口如下

struct B {
    bool isok;
    B& FromString(const char* str);
    B& FromValue(const rapidjson::Value& v);
    std::string ToString(int maxDecimalPlaces = 6);
    std::string ToPrettyString(int maxDecimalPlaces = 6);
    rapidjson::Value ToValue(rapidjson::Document::AllocatorType& allocator, bool copy = false);
}

struct A {
    double x;
    int y;
    std::vector<B> b;
    A& FromString(const char* str);
    A& FromValue(const rapidjson::Value& v);
    std::string ToString(int maxDecimalPlaces = 6);
    std::string ToPrettyString(int maxDecimalPlaces = 6);
    rapidjson::Value ToValue(rapidjson::Document::AllocatorType& allocator, bool copy = false);
}

功能如下：

函数签名	功能
A& FromString(const char* str);	从JSON格式字符串str解析数据，写入结构体
A& FromValue(const rapidjson::Value& v);	从rapidjson::Value中获取数据，写入结构体
std::string ToString(int maxDecimalPlaces = 6);	将结构体中数据序列化为字符串（紧凑），浮点数小数部分长度为maxDecimalPlaces
std::string ToPrettyString(int maxDecimalPlaces = 6);	将结构体中数据序列化为字符串（适合阅读），浮点数小数部分长度为maxDecimalPlaces
rapidjson::Value ToValue(rapidjson::Document::AllocatorType& allocator, bool copy = false);	将结构体中数据转化为rapidjson::Value，对于array<string>，copy用于控制是否采用copy-string策略（默认为const-string策略）注：这里可能有未发现的潜在问题

保留字

message, package, {}, ;, repeated, double, int32, int64, uint32, uint64, float, bool, string, //

语法

Program -> Package Message*
Package -> "package" id ";"
Message -> "message" id "{" Element* "}"
Element -> Type id ("=" num) ";" | "repeated" Type id ("=" num) ;"
Type -> id | "double" | "float" | "int32" | "uint32" | "int64" | "uint64" | "bool" | "string"

注1：("=" num)仅用于兼容proto文件格式，不起任何作用

注2：id允许包含数字与下划线，且不允许数字开头

安装

pip install proto2rapidjson

使用

在完成安装pip install .后，可以使用如下指令执行：

python -m proto2rapidjson -i <INPUT> -o <OUTPUT>

计划

• 添加序列化的模板
• 编写CLI，生成二进制文件并支持pip install .
• 完善测试与代码覆盖率测试
• 禁止相同id
• 允许在package处使用A.B.C生成C++中A::B::C的namespace