#include <iostream>
#include <utility>
#include <fstream>
#include <assert.h>
#include <time.h>
#if defined(RAWBUF_TEST_MODE)
#include "rawbuffer.h"
#include "test.h"
#else
//Some related compiler bug
//During the test, if you see warning"dereferencing pointer blabla does break strict-aliasing rules", it is a bug fixed in GCC4.5。
//测试中如果你看到警告"dereferencing pointer blabla does break strict-aliasing rules"，请勿介意，这是一个的GCC4.5修復的bug，O2或者O3优化时会给出这个提示。
//https://gcc.gnu.org/bugzilla/show_bug.cgi?id=39390
//
//https://bugs.llvm.org/show_bug.cgi?id=18009 clang-3.4 can not use our library, using clang-3.5 instead!
//overload << operator to enable output of std::pair.
//重载一下<< 操作符让std::pair支持输出到流
template<typename L, typename R>
std::ostream& operator << (std::ostream &ost, const std::pair<L, R>& rhs) {
ost << "fisrt: " << rhs.first << " " << "second: " << rhs.second;
return ost;
}
//We put the definition of the function ahead due to the following strange policy of clang compiler.
//I think it is a bug for clang but the maintainer does not.
//https://stackoverflow.com/questions/31036530/cannot-compile-code-with-clang-but-works-with-gcc?rq=1
struct mystruct0 {
int xx;
short yy;
int zz;
};//Yes, we support raw struct packed in raw buffer, if all the numeric member is portable!
//是的，我们支持原生的结构体，只要里面的数值类型都是可移植的。推荐使用int32_t, int16_t这样更有可移植性的类型。
//Do not use multiple inheritance. It will leads to several unportable layouts between several compilers.
//别使用多继承。会在各个编译器之间产生很多无法移植的内存布局。
struct mystruct1 : public mystruct0 {
};
//overload << operator to enable output of mystruct0.
//重载一下<< 操作符让mystruct0支持输出到流
std::ostream& operator<< (std::ostream &ost, const mystruct0& rhs) {
ost << "xx=" << rhs.xx << " " << "yy=" << rhs.yy << " " << "zz=" << rhs.zz;
return ost;
}
//Yes, we can use the packet data type that defined later as fields.
//是的，我们还可以使用延迟定义的包数据类型作为包的数据成员。
struct test_type1;
#include "rawbuffer.h"
//Between DEF_PACKET_BEGIN and DEF_PACKET_END are the data fields. test_type is the packet type name
//在DEF_PACKET_BEGIN 和 DEF_PACKET_END之间的是包的数据成员。test_type是包的类型名字
DEF_PACKET_BEGIN(test_type)
ADD_FIELD_REQUIRED(int, a)
//ADD_FIELD_REQUIRED will layout the field "a" like a c struct member "int a"
//ADD_FIELD_REQUIRED 会把a当C结构体的整数成员一样进行布局和存储
//So the packet in raw_buffer is a tree struct and the required fields are value of the tree node.
//所以在raw_buffer中包是一个树形的结构体，必须的字段会被视为树的节点的值。
//The rest fields are optional. They are son node of the current packet
//剩下的都是可选的字段. 他们是当前包的子节点。
ADD_FIELD(int, x)
ADD_FIELD(long long, y) // Do not use 64bit integer as required field,their alignment is not portable
ADD_FIELD(mystruct0, z)
ADD_FIELD(mystruct1, w)
//You can use variable-length integer, but it can not be accessed by pointer. So we need a default value
//for it is NULL. The defualt value should be the most usual number for the field.
//你可以使用变长整数，但是这就没法通过指针去访问数据了。所以你需要定义一个默认值来对付他没被赋值的场景。
//这个默认值最好是一个对于这个字段最频繁出现的数值。
ADD_VAR_INT(unsigned int, o, 1)
ADD_VAR_INT(int, p, 1)
ADD_VAR_INT(long long, q, 2)
//We store X - default for value X in fact. X - default is compressed as protobuf varint.
//We store 0 for o if o=1, store 4 for o if o=5, store -1 for o if o=0 (costing the most storage for the unsigned int!)。
//So be careful when the default value is not zero!
//当你赋值X的时候，我们实际会把X - default来仿照protobuf的存储格式来压缩存储
//如果你给o赋值1， 我们按0来存储；赋值5我们按4来存储；赋值0我们按-1来存储(对于无符号整数来说，这会消耗最多的字节数!!)。
//所以如果设置默认值不为0的时候要小心!
//"ANY" field definition can be used for any other packet type that even only declared.
//It does not lose any performanse but we can not estimate the packet(test_type) max size at compiling time.
//"ANY" 式的成员定义可以用于任何其他仅仅有声明的包类型。
//它不会带来任何性能的损失，但是会让我们无法在编译时估计包(test_type)的最大空间开销。
//test_type1 need to be defined by DEF_PACKET_BEGIN when test_type is used in your codes and test_type1 must be another packet type!
//当你开始使用test_type的时候，test_type1需要已被定义并且他必须也是通过DEF_PACKET_BEGIN定义的数据包类型。
ADD_PACKET_ANY(test_type1, u);
//test_type1 need to be defined by DEF_PACKET_BEGIN when test_type is used in your codes and test_type1 must be another packet type!
//当你开始使用test_type的时候，test_type1需要已被定义并且他必须也是通过DEF_PACKET_BEGIN定义的数据包类型。
ADD_PACKET_ARRAY_ANY(test_type1, v, 2);
//After protocol is published, we can only modify it safely by adding or removing optional fields at the back of the packet.
//协议公开之后，对协议安全的修改只允许在协议末尾增加或者删除字段。
DEF_PACKET_END
//Now lets turn to a harder one: test_type1
//好，现在我们来点复杂的协议: test_type1。
DEF_PACKET_BEGIN(test_type1)
//All the optional fields will be visited via their offset stored in the packet. The default offset type is uint32_t
//Our packet test_type1 here will not be bigger than 1<<16 in design of users. So we can use a smaller unsigned type instead to save space.
//所有的可选成员，都会通过在包中存储的他们的位置偏移量来进行访问。默认偏移量类型是uint32_t.
//这里我们的数据包test_type1按照使用者的设计，不会超过1<<16, 所以可以使用一个小一点的无符号数值类型来节省空间。
typedef unsigned short offset_type;
//We can define a fixed length array field like: char aa[12];
//我们可以定义一个定长的数组成员：char aa[12];
ADD_FIELD_ARRAY_REQUIRED(char, aa, 12)
//Ok, next!
//好的，再来一个
ADD_FIELD_ARRAY_REQUIRED(int, bb, 3)
//We can define an optioanl variable length vector field.
//我们也可以定义一个变长的可选的数组成员。注意32仅仅是个长度估计，用来初始化时评估预分配内存数量的，不会限制cc的大小，可以安全的随意修改。
ADD_FIELD_ARRAY(int, cc, 32)
//Here 32 just provides an estimation of ccfor the writer pre-allocation. It does not limit the size of cc.
//32 can be changed into other number after the protocol is published because it just affect the meory allocator.
//We can define a knownable packet as field. For safety it can not be required!
//我们还可以定义一个已知的包类型作为数据成员。为了安全（包类型可能增减成员），他不可以被声明为必须的。
ADD_PACKET(test_type, xx)
//just more fields..
//再来更多的数据成员
ADD_FIELD(int, yy)
ADD_FIELD_ARRAY(char, zz, 32)
ADD_PACKET(test_type, ww)
//We can define a optioanl variable length vector of knownable packet as field. For safety it can not be required!
//我们还可以定义一个已知的包类型的变长数组作为数据成员。为了安全（包类型可能增减成员），他不可以被声明为必须的。
ADD_PACKET_ARRAY(test_type, uu, 4)
ADD_PACKET_ARRAY(test_type, tt, 4)
//test_type1 can use the packet type itself, make a link list.
//test_type1 还可以使用自己类型,可以构造出链表效果。
ADD_PACKET_ANY(test_type1, vv)
//test_type1 can use the packet type itself as array, make a tree.
//test_type1 还可以使用自己类型做数组,可以构造出树的效果。
ADD_PACKET_ARRAY_ANY(test_type1, dd, 3)
//After protocol is published, we can only modify it safely by adding or removing optional fields at the back of the packet.
//Or update the size estimation of the optional array of cc, zz, uu.
//协议公开之后，对协议安全的修改只允许在协议末尾增加或者删除字段。或者修改对可选数组如cc,zz,uu,tt, dd的长度估计。
//DEF_PACKET_END
DEF_PACKET_END_FINAL
//If you are sure that test_type1 have not and will not add or delete any field, you can use DEF_PACKET_END_FINAL instead of DEF_PACKET_END to save sizeof(offset_type) bytes.
//如果你确认test_type1 过去和将来 都不会增加或者删除过字段，那么可以使用DEF_PACKET_END_FINAL代替DEF_PACKET_END来节省sizeof(offset_type) 个字节。
#ifdef RAWBUF_ENABLE_TEMPLATE_PACKET
//template packet definition
//使用模板的包类型定义
template<typename T
, typename Array_count_type = rawbuf_config::array_count_type
, bool is_raw_buf_test_result = rawbuf::is_rawbuf_struct<T>::result
>
DEF_PACKET_BEGIN(test_type2)
typedef Array_count_type array_count_type;
ADD_FIELD_REQUIRED(T, o)
ADD_FIELD(T, a)
ADD_PACKET_ANY(test_type2, b)
ADD_PACKET_ARRAY_ANY(test_type2, c, 3)
DEF_PACKET_END
//template specification or partial specification, and you need to mention how to specify.
//模板特化或者偏特化，需要你写出特化形式
template<typename T, typename Array_count_type> //
//DEF_PACKET_BEGIN(test_type2<T, false>) No! The c++ preproccesor will think "test_type2<T, false>" as two arguments "test_type2<T", " false>"
//宏不认识<> 所以他认为里面的,是分割用的。
//using ARGS_LIST to wrap any template arguments list.
//使用ARGS_LIST来把所有的模板参数列表给包起来
DEF_PACKET_BEGIN(test_type2<ARGS_LIST(T, Array_count_type, true)>)
typedef Array_count_type array_count_type;
ADD_PACKET(T, a)
ADD_PACKET(test_type2<int>, b) //Use
ADD_PACKET_ARRAY_ANY(test_type2, c, 3) //Here test_type2 is test_type2<ARGS_LIST(T, Array_count_type, true)> itself
ADD_FIELD(std::pair<ARGS_LIST(int, double)>, d) //ARGS_LIST should be used again.
ADD_FIELD_REQUIRED(std::pair<ARGS_LIST(int, double)>, e)
ADD_PACKET_ARRAY_ANY(test_type2<int>, f, 3)
DEF_PACKET_END
//We can use some container type;
//我们也可以使用一些容器类型
#include "rawbuffer_container.h"
//Following is a real protocol in work
template <typename T>
DEF_PACKET_BEGIN(test_type3)
ADD_FIELD_REQUIRED(char, packet_begin_tag) //The packet will begin with '<'
ADD_FIELD_REQUIRED(rawbuf_uint32, packet_size)
ADD_PACKET(rawbuf_queue<T>, packet_data)
ADD_FIELD(char, packet_end_tag) //The packet end with '>'
test_type3() {
this->packet_begin_tag('<');
this->packet_size(0);
}
void encode(rawbuf_builder<test_type3>& builder) {
builder->packet_end_tag('>');
builder->packet_size(builder.size());
}
DEF_PACKET_END
DEF_PACKET_BEGIN(twitter_msg)
ADD_FIELD_ARRAY(char, nick_name, 32)
ADD_FIELD_ARRAY(char, header_url, 64)
ADD_FIELD_ARRAY(char, twitter_content, 255)
ADD_VAR_INT(rawbuf_uint64, publish_time, 1508661161) //Select the publish time as default time to compress
DEF_PACKET_END
#endif
#endif
using namespace std;
#define OUTPUT_TEST(x) std::cout <<"Line " RAW_BUF_STRING(__LINE__) ": " RAW_BUF_STRING(x) << std::endl; x; std::cout << std::endl
//Now let us use our protocol
//好，我们来试试我们定义的协议。
//You'd better declare your protocol in a header file test_proto.h out of your source to make it shareable.
//We define our protocol by macro and maybe difficult to debug into source.
//We can generate a readable header file via preproccess and format tools like
//"gcc -E test_proto.h -P -nostdinc | astyle > proto.h"
//实际使用最好像test_proto.h 那样用一个单独的文件来声明协议（方便分发）。协议是用宏来定义的，可能不方便源码级调试。
//可以用"gcc -E test_proto.h -P -nostdinc | astyle > proto.h" 来利用预处理和astyle来生成一个可阅读的头文件。
//We provide "./proto_astyle.sh test_proto.h > proto.h" to help you simplify the command!
int main(){
cout << boolalpha ;
//If the packet test_type can be a tree, rawbuf_builder<test_type> is use to pre-allocate the tree and build the root node of the tree. Rellocation may happen if your optional array is assigned with size greater than its estimation in protocol.
//如果把包test_type看成一个数据包树，那么rawbuf_builder<test_type>就是用来初始化分配树的内存开销和构造这颗树的根的。如果可选的变长数组被赋值的长度超过了协议中的估计，那么可能会发生reallocation.
rawbuf_builder<test_type> instance;
//builder can be used as a smart pointer. Fields name is the function name for assignment.
//builder可以当成智能指针来用。数据成员名字则被当成函数名字用来进行赋值。
instance->x(0);
instance->y(1);
instance->a(2);
instance->o((unsigned int)-1);
instance->p(130);
instance->q(0x100010001ll); //4295032833
//() operator always results a raw pointer(of test_type), required fields can assigend via the raw pointer and a little quicker（can be ignored in fact）
//()操作符会返回一个原生的（test_type）指针，必须的字段可以通过原生指针进行赋值, 会快一点点（简直可以忽略）
instance()->a(3);
mystruct1 t1;
t1.xx = 2;
t1.yy = 3;
t1.zz = 4;
instance->z(t1);
//output function is only available for the raw pointer. The output is in json style. Char array will be output as c-string with proper escape.
//output函数只能通过原生指针来调用。输出是json格式的。char数组会自动当字符串来打印，并且会进行适当的转义。
instance()->output(std::cout);
cout << endl;
//We will use the following function to tag each output;
OUTPUT_TEST(instance()->output(std::cout));
test_type* pinstance = instance();
//Fields name is also the data visiting function name. It will return the data 地址.
//数据成员的名字也是数据访问的函数名字, 会返回数据成员的地址。
pinstance->z()->xx = 4;
pinstance->z()->yy = 4;
OUTPUT_TEST(pinstance->output(std::cout));
//Harder usage
//更复杂的用法
rawbuf_builder<test_type1> instance2;
//Every packet nodes in the packet tree can be created by assignment or alloc like following (for deeper assignment)
//数据包树里的每一个非根节点可以通过上面的赋值或者像下面这样分配来进行创建(然后再进一步的对子成员赋值)
rawbuf_writer<test_type> packet = instance2->xx<test_type1::alloc>();
//rawbuf_writer is the base class of rawbuf_builder, which provides the data assignment and visiting function shown above.
//rawbuf_writer 是rawbuf_builder的基类，提供了前面所展示的所有数据访问和赋值功能。
packet->x(5);
packet->w(t1);
instance2->yy(6);
instance2->aa("Sorry!"); //We support array direct assignment!
instance2->aa("Sorry!", 7); //Same effection...
memcpy(instance2()->aa(), "Sorry!", 7); //It is safe as the size of aa is 12.
instance2->zz("I say :\"Hello \\ world!\"");
int tester[] = {4,5};
instance2->bb(tester, 2); //The length of bb is still 3(the length of the required array is always fixed!), but we modify its first and second value.
instance2->cc(tester, 2); //The length of cc is 2(the length of the optional array is depending on the assignment!).
//The writer can not used for reading. You can use () to cast it to raw pointer to visit address of assigned field, like instance2()->bb().
//instance2() return a test_type1 pointer and ->bb() return its the address of field bb
//However the pointers may become invalid after further assginment of the owned builder or writer due to reallocation.
//So take care when using the raw pointer from writer.
//writer是不能用来读取数据的. 所以得使用()来转换成原生指针来访问yy。()->可以看成一个操作符嘛^_^
//instance2()返回一个test_type1指针，->bb()返回他的成员bb的地址。
//但是这些原生指针可能在被所属的writer或者builder进一步的赋值中因为reallocation失效，所以谨慎使用从writer中获取的指针。
//Let us start with a usual mistake.
//std::vecotr<int> x; x.push_back(4);x.push_back(4);x.push_back(4);x.push_back(4);
//x.push_back(*x.begin()); WARNING! DANGEROUS CODES!
//Dangerous codes: because push_back may lead to reallocation and make the argument of push_back invalid.
//危险的代码: 因为push_back可能导致reallocation然后让push_back的参数是个无效的引用
//So do not copy the field to another one in the same root builder until you guarantee it will not reallocate during the copy!
//所以除非你能保证拷贝时不会发生缓冲区重新分配, 否则不要把已有的数据成员拷贝到同一个根builder的其它数据成员上。
instance2->bb(instance2()->yy(), 1);
instance2->cc(instance2()->bb(), 1);
//Is the above codes safe? In fact raw_buffer has tried best to avoid reallocation. The defualt initial builder capacity can afford
//all the required and "non-any" optional fields size (size of optional array data based on the size_estimation arguments) and
//worst assignment order and alignment cost.
//Reallocation can and only can happen after following cases appear (may not immediately, it may reallocate at anytime of future assignment):
//0: your builder is constructed with your own capacity, not default.
//1: you assign an optional array field with size greater than its size estimation in defination.
//2: you re-assign an optional array.
//3. you assign an "any" packet (or array) field. Size of "any" fields is not including in the initial builder capacity.
//4. you assign a packet or array field,indirectly leading to case 1, 2, 3
//So the two assignment of the above codes are safe becase we do not have the above 5 behaviours till now.
//
//上面的代码安全吗？其实raw_buffer已经竭尽全力去避免reallocation. 默认的builder初始化容量能够装的下所有的必须和可选字段（
//可选数组字段的大小是根据他在定义中的size_estimation参数），能够承受最坏的赋值顺序所导致的对齐开销。
//reallocation可能也只可能在如下场景发生后发生（不一定立即发生，在此之后的任何赋值场景随时可能reallocation）：
//0: 你构造builder时使用了自定义的初始容量值。
//1: 你给一个可选数组字段，赋值的长度超过了他在定义时的长度估计。
//2: 你给一个可选数组字段重新赋值。
//3: 你给一个"any"类型字段赋值。"any"类型字段的大小是没有在builder的初始容量中进行计算的。
//4: 你给一个packet或者packet array赋值时，间接导致了1，2，3
//所以上面那2行赋值代码是安全的，因为距今为止我们没有上面提到的5种行为。
//But we can use "reference" instead of "copy" for optional field from another to avoid any possible rellocation.
//You can use a field A "reference" another field B only if
//0.they come from the same root builder.
//1.the parent field of A is allocated or assigned ealier than B.
//2.violation of the above two ruls leads to reference failed.
//但是我们可以让一个成员“引用”另一个成员而不是“拷贝”来避免任何可能的reallocation.
//仅当以下条件成立时可以让成员A引用成员B：
//0.他们来自同一个根builder；
//1.A的父节点比B更早分配或赋值；
//2.对以上2点的违反将会导致引用失败。
if(!instance2->yy<test_type1::add_ref>(instance2()->bb())){
//Parent node of yy is instance2 and bb is required field of instance2(so bb is allocated as soon as instance2)
//So it disobeys rule 1.
//yy的父节点是instance2 而 bb是instance2的必须字段（所以bb和instance2一起进行分配）
//所以这违背了规则1
cout << "Add reference must failed!" << endl;
}
if(instance2->yy<test_type1::add_ref>(instance2()->cc())){
cout << "Add reference must succeed!" << endl;
}
OUTPUT_TEST(instance2()->output(std::cout));
//Now we create packet node ww directly via assignment.
//* operator return the reference of the raw pointer
//现在我们通过赋值来创建非根节点ww
//* 操作符返回原生指针的引用。
packet = instance2->ww(*instance); //*instance == *(instance())
packet->w(t1);
instance2->zz("I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\""
"I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\""
"I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\""
"I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\""
"I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\""
"I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\""
"I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\"" "I say :\"Hello \\ world!\""
);
//This assignment size is far beyond the size estimation of zz defined in protocol and it may lead to reallocation of instance2. But every writer like "packet" is safe.
//这个赋值已经大大超过了zz在协议中定义时的长度估计, 这可能会导致instance2的重新分配空间。所有的现存的rawbuf_writer，像"packet"依然是安全的。
OUTPUT_TEST(instance2()->output(std::cout));
//instance2->zz("I say :\"Hello \\ world!\"");
//From now on, reallocation of instance2 may happen at anytime. Be careful of using the address of the assigned fields of instance2.
//从现在起，reallocation 随时可能发生在instance2身上。谨慎使用instance2上以赋值的成员的地址。
//Copy the packet itself to its field will lead infinite recursion and relocation and crash at last.
//把自己拷贝到自己的的成员上会导致无限循环,最终导致relocation而让输入参数无效。
//instance2.reserve(instance2.size()*8); //No matter how much the capcity is, it will be exhausted
//instance2->vv(*instance2); // And *instance2 must be an invalid reference finally.
//So we need to copy to another builder first.
rawbuf_builder<test_type1> instance3;
instance3->copy(*instance2);
instance2->vv(*instance3)->ww<test_type::alloc>()->p(2097152+8);
//vv.ww.p is assigned!
OUTPUT_TEST(instance2()->output(std::cout));
//Now we try re-assignment the packet node.
//现在我们来试试对已经赋值的节点重新赋值
packet = instance2->ww(*instance);
//instance2()->ww()->w() becomes null (as instance()->w() is null) and the memory previously used (in "packet->w(t1);" )
//is waste as that memory becomes a "memory fragment" and for time efficiency, we will not try to reuse it.
//So be careful for using re-assignment for all optional fields!
//instance2的ww字段的w字段现在变成了空，而且刚才w占据的空间出于时间效率会被浪费掉了而不会被重用。所以谨慎使用对可选成员重新赋值这个功能。
packet->p(65539);
packet->o(272629760);
packet->q(0x1000000000000002); //1152921504606846978
//The allocation or assignment of the packet array will return a rawbuf_writer_iterator, a sub-class of rawbuf_writer at the begin element.
//It supports the increament, [] or other pointer "shifting" operation. It becomes like a real pointer.
//对于包的数组的赋值或者分配会返回一个rawbuf_writer_iterator，他是rawbuf_writer的子类并位于数组第一个元素。
//他支持自增，[]下标操作或者其它移动操作。他变得像一个真正的指针了。
rawbuf_writer_iterator<test_type> it = instance2->uu<test_type1::alloc>(2);
it->x(3);
++it;
it->x(4);
it[size_t(-1)]->a(2);
(it-=1)->y(3);
(it++)->y(3);
(it--)->a(3);
//(it+1)->a(2); it is not supported because we have supported cast it to bool type, so it will lead to ambigious warning in GCC.
//Even you use raw pointer to visit, you also get an iterator to iterate the packet array.
//Becuase the content pointed by raw data maybe from outer data and its packet element may have different sizeof(test_type).
//Using ()operator to get raw pointer
//即使你使用原始指针来访问uu, 你依然只能得到一个遍历器来遍历。
//因为可能原始指针执行的内容是来自外部数据，里面的包数组元素可能有不同的可选字段数量导致大小和我们的sizeof(test_type)有所不同
//使用()操作符来获取原始指针
rawbuf_packet_iterator<test_type> iti = instance2()->uu();
cout << iti->a() << endl;
cout << iti()->a() << endl;
//it also can be assigned by other.
rawbuf_writer_iterator<test_type> itt = instance2->tt(instance(), 1
);
itt->a(-1);
//Now we will exam the "any" type field whether they are the same as "non-any" type
//现在我们检查下ANY类型的成员是否和非ANY类型的使用完全相同
rawbuf_writer_iterator<test_type1> itd = instance2->dd<test_type1::alloc>(2);
++itd;
itt->v(instance3(), 1)->xx(*instance)->v(instance3(), 1)->xx(*instance); //Amazing!
//The only difference is when we visit the packet "any" type, we need to mention its type.
//This is the cost of supporting C++03..
//有唯一一点不同：访问包数组时，any类型需要指明元素类型。
//这是兼容C++03的代价。
itt()->v<test_type1>();
itd->vv<test_type1::add_ref>(itt()->v<test_type1>()());
OUTPUT_TEST(instance2()->output(std::cout));
#ifdef RAWBUF_ENABLE_TEMPLATE_PACKET
//Now look at the template packet
rawbuf_builder<test_type2<int> > instance4;
instance4->a(3);
instance4->b<rawbuf_cmd::alloc>()->a(4);
instance4->c<rawbuf_cmd::alloc>(2)->a(-1);
OUTPUT_TEST(instance4()->output(std::cout));
rawbuf_builder<test_type2<test_type1> > instance5;
instance5->a(*instance2());
instance5->b(*instance4())->a(5);
instance5->c<rawbuf_cmd::alloc>(2)->a(*instance2());
instance5->d(std::make_pair(1, 2.3));
instance5->e(std::make_pair(4, 5.6));
OUTPUT_TEST(instance5()->output(std::cout));
rawbuf_builder<test_type3<int> > instance6;
rawbuf_writer<rawbuf_queue<int> > writer6 = instance6->packet_data<rawbuf_cmd::alloc>();
writer6->push_back(0);
writer6->push_back(1);
writer6->push_back(2);
instance6()->encode(instance6);
OUTPUT_TEST(instance6()->output(std::cout));
rawbuf_queue<int>* myqueue = instance6()->packet_data();
cout << "queue size: " << *myqueue->size() << endl;
for (const rawbuf_queue_node<int>* it = myqueue->begin(); it != 0; it = it->next()) {
cout << *it->value() << endl;
}
rawbuf_builder<test_type3<twitter_msg> > instance7;
rawbuf_writer<rawbuf_queue<twitter_msg> > writer7 = instance7->packet_data<rawbuf_cmd::alloc>();
{
rawbuf_writer<twitter_msg> msg_writer = writer7->alloc_back();
msg_writer->nick_name("yuanzhubi");
msg_writer->header_url("https://avatars1.githubusercontent.com/u/25676580?s=460&v=4");
msg_writer->twitter_content("The library is strongly recommended!");
msg_writer->publish_time(rawbuf_uint64(time(NULL)));
}
{
rawbuf_writer<twitter_msg> msg_writer = writer7->alloc_back();
msg_writer->nick_name("zy498420");
msg_writer->header_url("https://avatars0.githubusercontent.com/u/1190063?s=460&v=4");
msg_writer->twitter_content("We are improving it every week!");
msg_writer->publish_time(rawbuf_uint64(time(NULL)));
}
instance7()->encode(instance7);
OUTPUT_TEST(instance7()->output(std::cout));
#endif
//Now we write the date to file
//现在我们把数据写到文件里去
#ifndef PORT_TEST
{
ofstream test_out;
test_out.open("./test.data", ios_base::binary | ios_base::out);
//data() returns the buffer pointer
//size() returns the buffer size
test_out.write(instance2.data(), instance2.size());
test_out.flush();
test_out.close();
}
#endif
/***************************************************************
Now we can talk about the reader from received data
现在我们谈谈如何从从外部获取的数据中读取包成员
***************************************************************/
//do not use "char buffer[4096]" such local variable, it may not be properly 8bytes aligned! Only malloc or new gurantee the 8 bytes alignment (the local array of long long buffer[4096] in GCC-x86 system V ABI is still not aligned in 8 bytes but x64 aligned).
//不要使用"char buffer[4096]" 这样的局部变量, 这样的buffer未必已经8字节对齐. 只有malloc或者new可以确保8字节对齐，long long buffer[4096]在x86上gcc遵照system V ABI的实现也是没有8字节对齐的不过x64已经对齐了。
char *buffer = new char[4096*12];
ifstream test_in;
test_in.open("./test.data", ios_base::binary | ios_base::in | ios_base::ate);
size_t length = (size_t)test_in.tellg();
test_in.seekg (0, test_in.beg);
test_in.read(buffer, length);
const char* error_msg = rawbuf_has_error<test_type1>(buffer, length);
//This will check buffer as test_type1 and recursively check all the offset of the optional fields, whether they are out of buffer or not properly aligned, or the packet array has different optional fields.
//这会把buffer当成数据包test_type1去检查, 并且会递归的检查所有可选字段的偏移量是否有存在超出buffer范围或者没有正确对齐的情况,和包数组中的元素是否不具有相同的可选字段个数等异常情况。
if(!error_msg){
//Now we can use buffer as a struct if we guarantee the 8 bytes alignment of buffer! Every required fields must exits!
//检查通过！由于我们保证了缓冲区首部的8字节对齐，我们可以把缓冲区当结构体来用了。其中每个必须的字段都肯定是存在的！
OUTPUT_TEST(((test_type1*)buffer)->output(std::cout));
cout << ((test_type1*)buffer)->bb()[0] << endl;
//Optional fields may not assigned. We do not have zero length optional array.
//可选字段未必已经赋值.我们不会有0长度的可选数组。
int* cc = ((test_type1*)buffer)->cc();
if(cc){
test_type1::array_count_type ccsize = ((test_type1*)buffer)->cc<test_type1::get_count>(); (void)ccsize;
assert(ccsize);
cout << cc[0] << endl;
}
//But we do not check whether the char array is ended with '\0'.
//We do not assert every char array is stored with string.
//Using c_str command for either required or optional fields to visit it safely.
//但是我们并没有检查char数组是否用'\0'来结尾，因为我们并不假设char数组里存的就是字符串。
//我们可以使用c_str命令来安全的访问这些必须的或者可选的字段
const char* aa = ((test_type1*)buffer)->aa<test_type1::c_str>();
//For required fields, aa == 0 means '\0' is not found in its array(leading a strnlen cost).
if(aa != 0){
cout << aa << endl;
}
const char* zz = ((test_type1*)buffer)->zz<test_type1::c_str>();
//For optional fields, zz == 0 means zz was not assigned or not ended with '\0' .
if(zz != 0){
cout << zz << endl;
}
//For packet array, we do not get the array pointer but an iterator because optional fields of packet may change so it is dangerous to use ++ or [] for the array raw with wrong sizeof(test_type).
//对于包数组，我们并无法直接得到数组的地址指针而是一个迭代器，这是因为包的可选字段数量可能会发生变化，所以使用原生指针去做++或者[]操作是危险的，如果基于我们错误的sizeof(test_type)去移动指针。
rawbuf_packet_iterator<test_type> it = ((test_type1*)buffer)->uu();
test_type1::array_count_type psize = ((test_type1*)buffer)->uu<test_type::get_count>();
if(psize != 0 ){
for(size_t i = 0; i<psize; ++i,++it){
OUTPUT_TEST(it->output(std::cout));
}
}
}
//If a packet has so many optional fields and sub-fields but we only use very small number of them, rawbuf_has_error will be expensive.
//For example, a game role may have 1000+ attributes after level 50 but 10 before level 5， while most gamers are junior players(with low level). Then always full check of all the possible optional fields are usually useless.
//So we can check the fields only before we use it. But like jsoncpp, the "check and read" pattern is a little more complicated.
//如果一个包有很多可选字段，但是我们仅仅只用其中很少一部分的话，rawbuf_has_error就显得很昂贵了。
//例如一个游戏角色可能在50级后有1000多个属性，但是在5级前只有10个。并且多数玩家都是新手，等级不高。所以总是全量检查所有可能存在的可选字段就往往不必要了。
//所以我们可以仅仅在我们使用某个字段的时候去检查他。但是类似jsoncpp这种“检查并读”的模式用起来稍微有点复杂。
rawbuf_reader<test_type1> reader2;
if(!reader2.init(buffer, length)){
//Init failed! It just checked the top level validity of test_type1, not including its fields.
//初始化失败了。reader2.init 只会检查test_type1结构体自身的合法性，还不会去检查他的成员。
cout << reader2.error_msg() << endl;
delete []buffer;
return 0;
}
//Each data visiting function of reader will check the data validity. If the data was corrupted, reader will be destroyed to stop you to visit other fields!
//Data corruption is not local but always global!
//通过reader去访问数据成员会检查数据的合法性，如果发现数据被损坏了，reader会变得不可用来阻止你去访问其它数据！
//数据被损坏了的原因和影响不可能是局部的而总是全局的！
rawbuf_reader<test_type> reader1 = reader2->xx();
if(!reader1){
cout << "The field xx may be empty, or the data was totally corrupted!" << endl;
//To distinguish it, we need to check the reader: reader2.
//返回值没有获得数据？可能是xx根本就没有被赋值，也可能数据xx被损坏了
//为了区分这2种情况，我们需要再去检查reader。
if(!reader2){
cout << "The data was corrupted!" << endl;
//Through reader can not visit other fields, it can get the error message.
//尽管reader不能再用于访问数据, 他能告诉你到底检查到了什么样的错误。
cout << reader2.error_msg() << endl;
}
else{
cout << "The field xx is empty" << endl;
}
}
else{
//reader2->xx() does not check the fields of xx. So if we need to visit deeper for the optional fields of xx, we need to check its fields
//reader2->xx() 不会检查xx的字段合法性，所以如果想更深入的访问xx的可选字段，需要检查对应的字段。
int *x = reader1->x();
if(!x){
if(!reader1){
cout << "The data was corrupted!" << endl;
cout << reader1.error_msg() << endl;
}
else{
cout << "The field x is empty" << endl;
}
}
else{
cout << "Oh, I just get the fields x: " << *x << endl;
//maybe you are tired... you can take a full check for any reader, at any level
//可能你被这样抽丝剥茧挨个检查并访问数据弄的很疲惫了是吧，，你随时可以反悔，来个以某个局部节点为树根的全量检查
if(!rawbuf_has_error(reader1)){//Ok, you can visit every sub-optional fields of reader1 now.
// For the reader, () operation also results the raw pointer
test_type* pinstance = reader1();
OUTPUT_TEST(pinstance->output(std::cout));
}
}
}
//Now lets talk about the safely visiting the packet array via subclass of reader:rawbuf_reader_iterator
//现在我们再来谈谈如何通过reader的子类rawbuf_reader_iterator来安全的访问包数组
if (!reader2.init(buffer, length)) {
cout << reader2->error_msg() << endl;
exit(-1);
}
test_type1::array_count_type psize = reader2->uu<test_type1::get_count>();
if(psize != 0 ){
rawbuf_reader_iterator<test_type> uu = reader2->uu(); //reader2->uu() does not check the fields of uu.
for(size_t i = 0; i<psize && uu; ++i,++uu){
if(!rawbuf_has_error(uu)){ //Do a full check as following output will visit all the members.
OUTPUT_TEST(uu()->output(std::cout));
}
else{
cout << uu->error_msg() << endl;
break;
}
}
}
if(!reader2){
cout << reader2->error_msg() << endl;
}
#ifdef RAWBUF_ENABLE_TEMPLATE_PACKET
//Now look at the template packet
rawbuf_reader<test_type2<int> > reader4;
reader4.init(instance4.data(), instance4.size());
if (!reader4.init(instance4.data(), instance4.size())) {
cout << reader4->error_msg() << endl;
exit(-1);
}
if (!rawbuf_has_error(reader4)) {
OUTPUT_TEST(reader4()->output(std::cout));
}
else {
cout << "reader4:" << reader4->error_msg();
exit(-1);
}
rawbuf_reader<test_type2<test_type1> > reader5;
if (!reader5.init(instance5.data(), instance5.size())) {
cout << reader5->error_msg() << endl;
exit(-1);
}
if (!rawbuf_has_error(reader5)) {
OUTPUT_TEST(reader5()->output(std::cout));
}
else {
cout << "reader5:" << reader5->error_msg();
exit(-1);
}
#endif
//Finally we can examine the packet size
//最后我们看看这一个包的真正大小
cout << "size:" << instance2.size () << endl;
//Till now it is 2224.
return 0;
}