gencode——一个根据XML协议描述自动生成代码的小工具

apache

先看下笔者的XML协议描述：

1. <?xml version="1.0" encoding="utf-8"?>
   
2. <metalib>
   
3.     <macro name="HEAD_SIZE" value="3" />
   
4.     <macro name="MAX_BUFFER_SIZE" value="60" />
   
5.    
   
6.     <macro name="FORWARD_DIR" value="0" />
   
7.     <macro name="BACKWARD_DIR" value="1" />
   
8.     <macro name="STOP_DIR" value="2" />
   
9.    
   
10.     <macro name="PWM_ENA_PIN" value="3" />
    
11.     <macro name="PWM_ENB_PIN" value="5" />
    
12.     <macro name="PWM_IN1_PIN" value="8" />
    
13.     <macro name="PWM_IN2_PIN" value="7" />
    
14.     <macro name="PWM_IN3_PIN" value="12" />
    
15.     <macro name="PWM_IN4_PIN" value="11" />
    
16.    
    
17.     <macro name="LINE_MOVE_CMD" value="100" />
    
18.     <macro name="MOVE_CMD" value="101" />
    
19.    
    
20.     <struct name="LineMove">
    
21.         <field name="dir" type="uchar" />
    
22.         <field name="speed" type="uchar" />
    
23.     </struct>
    
24.     <struct name="Move">
    
25.         <field name="left_dir" type="uchar" />
    
26.         <field name="left_speed" type="uchar" />
    
27.         <field name="right_dir" type="uchar" />
    
28.         <field name="right_speed" type="uchar" />
    
29.     </struct>
    
30.     <struct name="Head">
    
31.         <field name="cmd" type="uchar" />
    
32.         <field name="body_len" type="ushort" />
    
33.     </struct>
    
34.    
    
35. </metalib>

复制代码

通过gencode.exe程序生成的代码：
proto.h

1. /*This head file is generated by code. Please do not edit!*/
   
2. #ifndef proto_H
   
3. #define proto_H
   
4. #ifdef __cplusplus
   
5. extern "C" {
   
6. #endif
   
7. 
   
8. #define HEAD_SIZE 3
   
9. #define MAX_BUFFER_SIZE 60
   
10. #define FORWARD_DIR 0
    
11. #define BACKWARD_DIR 1
    
12. #define STOP_DIR 2
    
13. #define PWM_ENA_PIN 3
    
14. #define PWM_ENB_PIN 5
    
15. #define PWM_IN1_PIN 8
    
16. #define PWM_IN2_PIN 7
    
17. #define PWM_IN3_PIN 12
    
18. #define PWM_IN4_PIN 11
    
19. #define LINE_MOVE_CMD 100
    
20. #define MOVE_CMD 101
    
21. 
    
22. #pragma pack(1)
    
23. typedef struct {
    
24.     unsigned char dir;
    
25.     unsigned char speed;
    
26. }LineMove;
    
27. extern inline int serialize_LineMove(LineMove *linemove, void *buffer, const int offset);
    
28. extern inline int deserialize_LineMove(void *buffer, LineMove *linemove, const int offset);
    
29. 
    
30. typedef struct {
    
31.     unsigned char left_dir;
    
32.     unsigned char left_speed;
    
33.     unsigned char right_dir;
    
34.     unsigned char right_speed;
    
35. }Move;
    
36. extern inline int serialize_Move(Move *move, void *buffer, const int offset);
    
37. extern inline int deserialize_Move(void *buffer, Move *move, const int offset);
    
38. 
    
39. typedef struct {
    
40.     unsigned char cmd;
    
41.     unsigned short body_len;
    
42. }Head;
    
43. extern inline int serialize_Head(Head *head, void *buffer, const int offset);
    
44. extern inline int deserialize_Head(void *buffer, Head *head, const int offset);
    
45. 
    
46. static int serialize(void *stru, void *buffer, int size, const int offset);
    
47. static int deserialize(void *buffer, void *stru, int size, const int offset);
    
48. 
    
49. #pragma pack()
    
50. #ifdef __cplusplus
    
51. }
    
52. #endif
    
53. #endif
    

复制代码

proto.c

1. /*This source file is generated by code. Please do not edit!*/
   
2. #include "proto.h"
   
3. 
   
4. static int serialize(void *stru, void *buffer, int size, const int offset)
   
5. {
   
6.     char *p_stru = (char *)stru;
   
7.     char *p_buffer = (char *)(buffer + offset);
   
8.    
   
9.     while(*p_buffer++ = *p_stru++, size--);
   
10.    
    
11.     return size + offset;
    
12. }
    
13. static int deserialize(void *buffer, void *stru, int size, const int offset)
    
14. {
    
15.     char *p_stru = (char *)stru;
    
16.     char *p_buffer = (char *)(buffer + offset);
    
17. 
    
18.     while(*p_stru++ = *p_buffer++, size--);
    
19.    
    
20.     return size + offset;
    
21. }
    
22. 
    
23. inline int serialize_LineMove(LineMove *linemove, void *buffer, const int offset)
    
24. {
    
25.     return serialize(linemove, buffer, sizeof(*linemove), offset);
    
26. }
    
27. 
    
28. inline int deserialize_LineMove(void *buffer, LineMove *linemove, const int offset)
    
29. {
    
30.     return deserialize(buffer, linemove, sizeof(*linemove), offset);
    
31. }
    
32. 
    
33. inline int serialize_Move(Move *move, void *buffer, const int offset)
    
34. {
    
35.     return serialize(move, buffer, sizeof(*move), offset);
    
36. }
    
37. 
    
38. inline int deserialize_Move(void *buffer, Move *move, const int offset)
    
39. {
    
40.     return deserialize(buffer, move, sizeof(*move), offset);
    
41. }
    
42. 
    
43. inline int serialize_Head(Head *head, void *buffer, const int offset)
    
44. {
    
45.     return serialize(head, buffer, sizeof(*head), offset);
    
46. }
    
47. 
    
48. inline int deserialize_Head(void *buffer, Head *head, const int offset)
    
49. {
    
50.     return deserialize(buffer, head, sizeof(*head), offset);
    
51. }
    

复制代码

下面是使用以上生成代码的Arduino主文件sample.ino

1. /** 示例
   
2.     By Apache([email protected]) 2012/11/30
   
3. */
   
4. #include "proto.h"
   
5. 
   
6. #define SET_LEFT_PWM(SPEED) analogWrite(PWM_ENB_PIN, (SPEED))
   
7. #define SET_RIGHT_PWM(SPEED) analogWrite(PWM_ENA_PIN, (SPEED))
   
8. #define SET_DIR(DIR, XPIN, YPIN) \
   
9.     do { \
   
10.         if(DIR != STOP_DIR) {\
    
11.             digitalWrite(XPIN, (DIR)); \
    
12.             digitalWrite(YPIN, !(DIR)); \
    
13.         }else {\
    
14.             digitalWrite(XPIN, 0); \
    
15.             digitalWrite(YPIN, 0); \
    
16.         } \
    
17.     }while(0)
    
18.    
    
19. #define SET_LEFT_DIR(DIR) SET_DIR(DIR, PWM_IN3_PIN, PWM_IN4_PIN)
    
20. #define SET_RIGHT_DIR(DIR) SET_DIR(DIR, PWM_IN1_PIN, PWM_IN2_PIN)
    
21. 
    
22. #define SET_MOTOR(LSPD, LDIR, RSPD, RDIR) \
    
23.     do { \
    
24.         SET_LEFT_PWM((LSPD)); \
    
25.         SET_RIGHT_PWM((RSPD)); \
    
26.         SET_LEFT_DIR((LDIR)); \
    
27.         SET_RIGHT_DIR((RDIR)); \
    
28.     }while(0)
    
29.    
    
30. static uint8_t waiting_head = 1;
    
31. static Head head;
    
32. 
    
33. void init_pin()
    
34. {
    
35.     uint8_t outputs[] = {
    
36.         PWM_ENA_PIN, PWM_IN1_PIN, PWM_IN2_PIN,
    
37.         PWM_ENB_PIN, PWM_IN3_PIN, PWM_IN4_PIN };
    
38.     uint8_t inputs[] = {};
    
39.     uint8_t i, ocnt = sizeof(outputs), icnt = sizeof(inputs);
    
40.    
    
41.     for(i = 0; i < ocnt; i++) {
    
42.         pinMode(outputs[i], OUTPUT);
    
43.     }
    
44.     for(i = 0; i < icnt; i++) {
    
45.         pinMode(inputs[i], INPUT);
    
46.     }
    
47. }
    
48. void setup()
    
49. {
    
50.     Serial.begin(9600);
    
51.     init_pin();
    
52. }
    
53. 
    
54. void on_line_move(uint8_t *buffer)
    
55. {
    
56.     LineMove linemove;
    
57.    
    
58.     deserialize_LineMove(buffer, &linemove, 0);
    
59.     SET_MOTOR(linemove.speed, linemove.dir, linemove.speed, linemove.dir);
    
60. }
    
61. 
    
62. void on_move(uint8_t *buffer)
    
63. {
    
64.     Move move;
    
65.    
    
66.     deserialize_Move(buffer, &move, 0);
    
67.     SET_MOTOR(move.left_speed, move.left_dir, move.right_speed, move.right_dir);
    
68. }
    
69. 
    
70. void proto_process(uint32_t cmd, uint8_t *buffer)
    
71. {
    
72.     switch(cmd) {
    
73.         case LINE_MOVE_CMD:
    
74.             on_line_move(buffer);
    
75.             break;
    
76.         case MOVE_CMD:
    
77.             on_move(buffer);
    
78.             break;
    
79.         default:
    
80.             break;
    
81.     }
    
82. }
    
83. void recv_package()
    
84. {
    
85.     int nbytes;
    
86.     uint8_t buffer[MAX_BUFFER_SIZE] = "";
    
87.    
    
88.     nbytes = Serial.available();
    
89.     if(waiting_head) {
    
90.         if(nbytes >= HEAD_SIZE) {
    
91.             Serial.readBytes((char *)buffer, HEAD_SIZE);
    
92.             deserialize_Head(buffer, &head, 0);
    
93.             waiting_head = 0;
    
94.         }
    
95.     }
    
96.     else {
    
97.         if(nbytes >= head.body_len) {
    
98.             Serial.readBytes((char *)buffer, head.body_len);
    
99.             proto_process(head.cmd, buffer);
    
100.             waiting_head = 1;
     
101.         }
     
102.     }
     
103. }
     
104. void loop()
     
105. {
     
106.     recv_package();
     
107. }

复制代码

下面是自动生成的python代码：
proto.py

1. #-*- coding: utf-8 -*-
   
2. # This script is generated by code. Please do not edit!
   
3. 
   
4. from struct import pack, unpack
   
5. 
   
6. PACK_TYPE_DICT = {
   
7.     "char": ("b", 1),
   
8.     "uchar": ("B", 1),
   
9.     "short": ("h", 2),
   
10.     "ushort": ("H", 2),
    
11.     "int": ("i", 4),
    
12.     "uint": ("I", 4),
    
13.     "long": ("l", 4),
    
14.     "ulong": ("L", 4),
    
15.     "longlong": ("q", 8),
    
16.     "ulonglong": ("Q", 8),
    
17.     "float": ("f", 4),
    
18.     "double": ("d", 8),
    
19. }
    
20. 
    
21. class Codec:
    
22.     @classmethod
    
23.     def serialize(self, obj):
    
24.         __buffer = []
    
25.         for field_pktype in obj._field_pktype:
    
26.             field, pktype = field_pktype[0], PACK_TYPE_DICT[field_pktype[1]][0]
    
27.             value = obj.__dict__.get(field)
    
28.             if not value: value = 0
    
29.             __buffer.append(pack(pktype, value))
    
30.         
    
31.         return ''.join(__buffer)
    
32. 
    
33.     @classmethod
    
34.     def deserialize(self, obj, buffer):
    
35.         offset = 0
    
36.         for field_pktype in obj._field_pktype:
    
37.             field = field_pktype[0]
    
38.             pktype, size = PACK_TYPE_DICT[field_pktype[1]]
    
39.             obj.__dict__[field] = unpack(pktype, buffer[offset: offset + size])[0]
    
40.             offset += size
    
41.             
    
42.         return offset
    
43. 
    
44. 
    
45. class MetaClass(type):
    
46.     def __init__(cls, name, bases, dict):
    
47.         def _init(cls, **_dict):
    
48.             for field, val in _dict.items():
    
49.                 setattr(cls, field, val)
    
50.         def _serialize(cls, **args):
    
51.             return dict["_codec"].serialize(cls, **args)
    
52.         def _deserialize(cls, buffer, **args):
    
53.             return dict["_codec"].deserialize(cls, buffer, **args)
    
54.         
    
55.         for field, _ in dict["_fields"]:
    
56.             setattr(cls, field, None)
    
57.             
    
58.         setattr(cls, "__init__", _init)
    
59.         setattr(cls, "_field_pktype", dict["_fields"])
    
60.         setattr(cls, "serialize", _serialize)
    
61.         setattr(cls, "deserialize", _deserialize)
    
62.         
    
63.         delattr(cls, "_fields")
    
64.         delattr(cls, "_codec")
    
65.         
    
66.         super(MetaClass, cls).__init__(name, bases, dict)
    
67. 
    
68. HEAD_SIZE = 3
    
69. MAX_BUFFER_SIZE = 60
    
70. FORWARD_DIR = 0
    
71. BACKWARD_DIR = 1
    
72. STOP_DIR = 2
    
73. PWM_ENA_PIN = 3
    
74. PWM_ENB_PIN = 5
    
75. PWM_IN1_PIN = 8
    
76. PWM_IN2_PIN = 7
    
77. PWM_IN3_PIN = 12
    
78. PWM_IN4_PIN = 11
    
79. LINE_MOVE_CMD = 100
    
80. MOVE_CMD = 101
    
81. 
    
82. LineMove = MetaClass(
    
83. name="LineMove",
    
84. bases=(),
    
85. dict=dict(
    
86.     _codec=Codec,
    
87.     _fields=(
    
88.             (u'dir', u'uchar'),
    
89.             (u'speed', u'uchar')
    
90.         )
    
91. )
    
92. )
    
93. 
    
94. Move = MetaClass(
    
95. name="Move",
    
96. bases=(),
    
97. dict=dict(
    
98.     _codec=Codec,
    
99.     _fields=(
    
100.             (u'left_dir', u'uchar'),
     
101.             (u'left_speed', u'uchar'),
     
102.             (u'right_dir', u'uchar'),
     
103.             (u'right_speed', u'uchar')
     
104.         )
     
105. )
     
106. )
     
107. 
     
108. Head = MetaClass(
     
109. name="Head",
     
110. bases=(),
     
111. dict=dict(
     
112.     _codec=Codec,
     
113.     _fields=(
     
114.             (u'cmd', u'uchar'),
     
115.             (u'body_len', u'ushort')
     
116.         )
     
117. )
     
118. )
     

复制代码

烧进去代码的后，我使用上面的py文件写了一个测试脚本：
test_proto.py

1. #-*- coding: utf-8 -*-
   
2. #示例, 测试LineMove协议
   
3. #By Apache([email protected]) 2012/11/20
   
4. 
   
5. import sys
   
6. try:
   
7.     import serial
   
8. except ImportError:
   
9.     print "Import serial error"
   
10.     sys.exit(1)
    
11. import proto
    
12. from time import sleep
    
13. 
    
14. COM = "COM3"
    
15. BAUND=9600
    
16. 
    
17. print u"正在打开串口..."
    
18. try:
    
19.     ser = serial.Serial(COM, BAUND)
    
20.     sleep(2)
    
21. except Exception, e:
    
22.     print e
    
23.     sys.exit(1)
    
24. print u"已打开, 开始协议测试..."
    
25. 
    
26. class TestLineMove:
    
27.     def __init__(self):
    
28.         self.head = proto.Head(cmd=proto.LINE_MOVE_CMD)
    
29.         self.body = proto.LineMove()
    
30.    
    
31.     def __sendpkg(self):
    
32.         body_buffer = self.body.serialize()
    
33.         self.head.body_len = len(body_buffer)
    
34.         head_buffer = self.head.serialize()
    
35.         ser.write("%s%s" % (head_buffer, body_buffer))
    
36.         
    
37.     def __line_move(self, msg, dir=0, speed=100, t=2):
    
38.         self.body.dir = dir
    
39.         self.body.speed = speed
    
40.         print msg
    
41.         self.__sendpkg()
    
42.         sleep(t)
    
43.         
    
44.     def test(self):
    
45.         print u"LineMove协议测试"
    
46.         self.__line_move(u"低速前进两秒", dir=0, speed=100, t=2)
    
47.         self.__line_move(u"高速前进两秒", dir=0, speed=200, t=2)
    
48.         self.__line_move(u"低速后退两秒", dir=1, speed=100, t=2)
    
49.         self.__line_move(u"高速后退两秒", dir=1, speed=200, t=2)
    
50.         self.__line_move(u"停止", dir=2, speed=0, t=0)
    
51. 
    
52. if __name__ == "__main__":
    
53.     TestLineMove().test()
    
54.    
    
55. ser.close()

复制代码

运行该脚本，测试效果良好，以后可以不用总是发ASCII码了……

下面是gencode的使用帮助：

更多的详细说明和示例代码见附件：

test01

高{:soso_e142:}

friskit

哈哈哈这个强

ttyp

有点一次描述，到处编译的味道，呵呵，XML的文档写写啊

987354117

没看懂  能解释一下否？

acbear

很牛逼的工具，可以自己修改下，生成其他的代码吗？
楼主能不能整个详细的教程？

apache

acbear 发表于 2012-12-2 22:22
很牛逼的工具，可以自己修改下，生成其他的代码吗？
楼主能不能整个详细的教程？

完全可以，只要按照示例，自己可以随意修改XML协议，然后通过gencode生成代码
这个工具的目的就是将程序的数据层和逻辑层分离
方便我们更快的开发上位机与Arduino的通信程序~

详细的教程的话，我暂时没有时间写，并且个人觉得示例已经写的很清楚了
如果大家有些Protocol buffers的经验会更容易理解

其它不理解的地方可以一起回帖交流

这版本还比较初级，如果需要源码可以email我索取

bigfinger

apache 发表于 2012-12-3 10:23
完全可以，只要按照示例，自己可以随意修改XML协议，然后通过gencode生成代码
这个工具的目的就是将程序 ...

请发我一份，多谢！
[email protected]