support xml (#1)

* support xml and fix clang warning
* support custom encode/decode
* update readme

Author: xyz347

README.md

@@ -1,7 +1,8 @@
 xpack
 ====
-* 用于在C++结构体和json之间互相转换, xml/bson将很快支持。
+* 用于在C++结构体和json/xml之间互相转换, bson将很快支持。
 * 只需要头文件, 无需编译库文件。
+* 具体可以参考example的例子
 
 ------
 * [基本用法](#基本用法)
@@ -11,9 +12,11 @@ xpack
 * [位域](#位域)
 * [继承](#继承)
 * [枚举](#枚举)
+* [自定义编解码](#自定义编解码)
 * [char数组](#char数组)
 * [第三方类和结构体](#第三方类和结构体)
 * [格式化缩进](#格式化缩进)
+* [XML数组](#xml数组)
 * [Qt支持](#qt支持)
 * [重要说明](#重要说明)
 
@@ -89,6 +92,7 @@ FLAG
 	- 0 没有任何FLAG
 	- OE omitempty，encode的时候，如果变量是0或者空字符串或者false，则不生成对应的key信息
 	- M mandatory，decode的时候，如果这个字段不存在，则抛出异常，用于一些id字段。
+    - ATTR attribute，xml encode的时候，把值放到attribute里面。
 - O。等价于X(F(0), ...) 没有任何FLAG。
 - M。等价于X(F(M)，...) 表示这些字段是必须存在的。
 - A。[别名](#别名)，A(member1, alias1, member2, alias2...)
@@ -234,10 +238,22 @@ int main(int argc, char *argv[]) {
 
 ```
 
+自定义编解码
+----
+应用场景：部分类型可能不想按结构体变量逐个编码，比如定义了一个时间结构体：
+```C++
+struct Time {
+    long ts; //unix timestamp
+};
+```
+并不希望编码成{"ts":1218196800} 这种格式，而是希望编码成"2008-08-08 20:00:00"这种格式，这个时候就可以用自定义编解码实现。
+
+- 可以参考[例子](example/xtype.cpp)
+
 char数组
 ----
 - **缺省是不支持char数组的**
-- 修改[config.h](config.h)，使能XPACK_SUPPORT_CHAR_ARRAY这个宏即可。也可以直接在编译选项加上这个定义。
+- 修改[config.h](config.h)，开启XPACK_SUPPORT_CHAR_ARRAY这个宏即可。也可以直接在编译选项加上这个定义。
 - **除了char，其他类型不支持数组**
 
 ```C++
@@ -311,11 +327,21 @@ int main(int argc, char *argv[]) {
 
 格式化缩进
 ----
-- encode缺省生成的json是没有缩进的，适合程序使用，如果让人读，可以进行缩进。
+- encode缺省生成的json/xml是没有缩进的，适合程序使用，如果让人读，可以进行缩进。
 - encode的最后两个参数控制
 	- indentCount 表示缩进的字符数，<0表示不缩进，0则是换行但是不缩进
 	- indentChar 表示缩进的字符，用空格或者制表符
 
+XML数组
+----
+- 数组会用"x"作为标签，比如"ids":[1,2,3]，对应的xml是:
+``` xml
+<ids>
+    <x>1</x>
+    <x>2</x>
+    <x>3</x>
+</ids>
+```
 
 Qt支持
 ----
@@ -329,4 +355,6 @@ Qt支持
 - vc6不支持。
 - msvc没有做很多测试，只用2019做过简单测试。
 - json的序列化反序列化用的是[rapidjson](https://github.com/Tencent/rapidjson)
+- xml的反序列化用的是[rapidxml](http://rapidxml.sourceforge.net)
+- xml的序列化是我自己写的，没有参考RFC，可能有和标准不一样的地方.
 - 有疑问可以加QQ群878041110

example/alias.cpp

@@ -22,7 +22,7 @@ using namespace std;
 struct Test {
     long uid;
     string  name;
-    XPACK(A(uid, "id"), O(name)); // "uid"的别名是"id"
+    XPACK(A(uid, "id"), O(name));
 };
 
 int main(int argc, char *argv[]) {

example/build_json.cpp

@@ -0,0 +1,34 @@
+/*
+* Copyright (C) 2021 Duowan Inc. All rights reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#include <iostream>
+#include "xpack/json.h"
+
+using namespace std;
+
+int main(int argc, char *argv[]) {
+    xpack::JsonEncoder en;
+    en.ObjectBegin(NULL);
+
+    vector<int> vi(3);
+    vi[0] = 1;
+    vi[1] = 2;
+    vi[2] = 3;
+    en.encode("vv", vi, NULL);
+    en.ObjectEnd(NULL);
+    cout<<en.String()<<endl;
+    return 0;
+}

example/makefile

@@ -1,8 +1,12 @@
+ifeq ($(GPP),)
+GPP=g++
+endif
+
 SRC=$(wildcard *.cpp)
 TAR=$(basename $(SRC))
 
 %:%.cpp
-	g++ -o $@ $< -I ../.. -DXPACK_SUPPORT_CHAR_ARRAY
+	$(GPP) -o $@ $< -I ../.. -DXPACK_SUPPORT_CHAR_ARRAY
 	@echo ============ run $@ ================
 	@./$@
 	@-rm $@

example/msvc.make

@@ -0,0 +1,12 @@
+SRC=$(wildcard *.cpp)
+TAR=$(SRC:.cpp=.exe)
+
+%.exe:%.cpp
+	cl /Fe:${CURDIR}/$@ $< /EHsc -I ../.. -DXPACK_SUPPORT_CHAR_ARRAY
+	@echo ============ run $@ ================
+	@$@
+
+tar:$(TAR)
+	@echo -------test done-------
+	@-del *.obj
+	@-del *.exe

example/my_encoder.cpp

@@ -0,0 +1,34 @@
+#include <iostream>
+#include "xpack/json.h"
+
+class MemberList {
+public:
+    std::vector<std::string> members;
+
+    template<class T>
+    bool encode(const char *key, const T&val, const xpack::Extend *ext) {
+        members.push_back(std::string(key));
+        return true;
+    }
+};
+
+template <class T>
+std::string GetMembers(const T&val) {
+    MemberList m;
+    val.__x_pack_encode(m, val, 0);
+
+    return xpack::json::encode(m.members);
+}
+
+
+struct Test {
+    int a;
+    int b;
+    XPACK(O(a,b));
+};
+
+int main(int argc, char *argv[]) {
+    Test t;
+    std::cout<<GetMembers(t)<<std::endl;
+    return 0;
+}

example/xpack_out.cpp

@@ -14,18 +14,21 @@
 * limitations under the License.
 */
 
-#include <sys/time.h>
+// #include <sys/time.h> linux only
 #include <iostream>
 #include "xpack/json.h"
+#ifndef _MSC_VER
+#include <sys/time.h>
+#endif
 
 using namespace std;
 
-/*
+#ifdef _MSC_VER
 struct timeval {
-    time_t      tv_sec;
-    suseconds_t tv_usec;
+    long tv_sec;
+    long tv_usec;
 };
-*/
+#endif
 
 // timeval is thirdparty struct
 XPACK_OUT(timeval, O(tv_sec, tv_usec));

example/xtype.cpp

@@ -0,0 +1,119 @@
+/*
+* Copyright (C) 2021 Duowan Inc. All rights reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#include <iostream>
+#include "xpack/xtype.h"
+#include "xpack/json.h"
+#include "xpack/xml.h"
+
+using namespace std;
+
+struct Date {
+    long unix_time;
+};
+
+namespace xpack { // must define in namespace xpack
+
+template<>
+struct is_xpack_xtype<Date> {static bool const value = true;};
+
+// implement decode
+template<class OBJ>
+bool xpack_xtype_decode(OBJ &obj, const char*key, Date &val, const Extend *ext) {
+    std::string str;
+    obj.decode(key, str, ext);
+    if (str.empty()) {
+        return false;
+    }
+
+#ifndef _MSC_VER
+    tm ttm;
+
+    if (0 != strptime(str.c_str(), "%Y-%m-%d %H:%M:%S", &ttm)) {
+        val.unix_time = mktime(&ttm);
+    } else {
+        val.unix_time = 0;
+    }
+#else
+    static int days[]={31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 32};
+    struct tm ttm={0};
+    sscanf_s(str.c_str(), "%d-%d-%d %d:%d:%d", &ttm.tm_year, &ttm.tm_mon, &ttm.tm_mday, &ttm.tm_hour, &ttm.tm_min, &ttm.tm_sec);
+    ttm.tm_mon-=1; // mon[0-11]
+    ttm.tm_year-=1900; // since 1900
+    val.unix_time = mktime(&ttm);
+#endif
+    return true;
+}
+
+// implement encode
+template<class OBJ>
+bool xpack_xtype_encode(OBJ &obj, const char*key, const Date &val, const Extend *ext) {
+    time_t tt = (time_t)val.unix_time;
+    tm     ttm;
+
+#ifndef _MSC_VER
+    localtime_r(&tt, &ttm);
+#else
+    localtime_s(&ttm, &tt);
+#endif
+
+    char buf[64];
+    strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S", &ttm);
+    return obj.encode(key, buf, ext);
+}
+
+}
+
+struct User {
+    int64_t id;
+    string  name;
+    string  mail;
+    Date    d;
+    User(int64_t i=0, const string& n="", const string& m="", long _d=0):id(i),name(n),mail(m){d.unix_time = _d;}
+    XPACK(O(id, name, mail, d));
+};
+
+struct Group {
+    string  name;
+    int64_t master;
+    vector<User> members;
+    XPACK(O(name, master, members));
+};
+
+int main(int argc, char *argv[]) {
+    Group g;
+    g.name = "C++";
+    g.master = 2019;
+    g.members.resize(2);
+    g.members[0] = User(1, "Jack", "jack@xpack.com", 1);
+    g.members[1] = User(2, "Pony", "pony@xpack.com", 1609249232);
+
+    string json = xpack::json::encode(g, 0, 2, ' ');
+    cout<<json<<endl;
+
+    string xml = xpack::xml::encode(g, "root", 0, 2, ' ');
+    cout<<xml<<endl;
+
+    Group n1;
+    xpack::json::decode(json, n1);
+    cout<<n1.name<<';'<<n1.members[0].name<<';'<<n1.members[0].d.unix_time<<endl;
+
+    Group n2;
+    xpack::xml::decode(xml, n2);
+    cout<<n2.name<<';'<<n2.members[1].name<<';'<<n2.members[1].d.unix_time<<endl;
+
+    return 0;
+}

extend.h

@@ -31,6 +31,8 @@ namespace xpack {
 #define X_PACK_FLAG_OE (1<<0) // omitempty, in encode
 #define X_PACK_FLAG_M  (1<<1) // mandatory, in decode
 
+#define X_PACK_FLAG_ATTR (1<<15) // for xml encode, encode in attribute
+
 // control flag
 #define X_PACK_CTRL_FLAG_INHERIT (1<<0)
 
@@ -97,28 +99,31 @@ struct Extend {
         }
     }
 
-    int Flag() const {
-        if (NULL == this) {
+    static int Flag(const Extend *ext) {
+        if (NULL == ext) {
             return 0;
         } else {
-            return flag;
+            return ext->flag;
         }
     }
 
-    int CtrlFlag() const {
-        if (NULL == this) {
+    static int CtrlFlag(const Extend *ext) {
+        if (NULL == ext) {
             return 0;
         } else {
-            return ctrl_flag;
+            return ext->ctrl_flag;
         }
     }
 
 
-    bool OmitEmpty() const {
-        return NULL!=this && (this->flag&X_PACK_FLAG_OE);
+    static bool OmitEmpty(const Extend *ext) {
+        return NULL!=ext && (ext->flag&X_PACK_FLAG_OE);
+    }
+    static bool Mandatory(const Extend *ext) {
+        return NULL!=ext && (ext->flag&X_PACK_FLAG_M);
     }
-    bool Mandatory() const {
-        return NULL!=this && (this->flag&X_PACK_FLAG_M);
+    static bool Attribute(const Extend *ext) {
+        return NULL!=ext && (ext->flag&X_PACK_FLAG_ATTR);
     }
 };