struct-frame 0.0.25__py3-none-any.whl → 0.0.28__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of struct-frame might be problematic. Click here for more details.
- struct_frame/__init__.py +2 -1
- struct_frame/c_gen.py +72 -9
- struct_frame/generate.py +215 -9
- struct_frame/gql_gen.py +207 -0
- struct_frame/py_gen.py +79 -6
- struct_frame/ts_gen.py +83 -15
- struct_frame-0.0.28.dist-info/METADATA +311 -0
- struct_frame-0.0.28.dist-info/RECORD +12 -0
- struct_frame/boilerplate/c/struct_frame.h +0 -103
- struct_frame/boilerplate/c/struct_frame_cpp.h +0 -41
- struct_frame/boilerplate/c/struct_frame_gen.h +0 -1
- struct_frame/boilerplate/c/struct_frame_parser.h +0 -101
- struct_frame/boilerplate/c/struct_frame_types.h +0 -67
- struct_frame/boilerplate/py/__init__.py +0 -0
- struct_frame/boilerplate/py/struct_frame_parser.py +0 -118
- struct_frame/boilerplate/ts/struct_frame.ts +0 -65
- struct_frame/boilerplate/ts/struct_frame_gen.ts +0 -7
- struct_frame/boilerplate/ts/struct_frame_parser.ts +0 -98
- struct_frame/boilerplate/ts/struct_frame_types.ts +0 -80
- struct_frame-0.0.25.dist-info/METADATA +0 -29
- struct_frame-0.0.25.dist-info/RECORD +0 -22
- {struct_frame-0.0.25.dist-info → struct_frame-0.0.28.dist-info}/WHEEL +0 -0
- {struct_frame-0.0.25.dist-info → struct_frame-0.0.28.dist-info}/licenses/LICENSE +0 -0
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
#pragma once
|
|
2
|
-
|
|
3
|
-
#include "struct_frame_parser.h"
|
|
4
|
-
#include "struct_frame_types.h"
|
|
5
|
-
|
|
6
|
-
class StructFrameDevice : public struct_buffer {
|
|
7
|
-
public:
|
|
8
|
-
StructFrameDevice(struct_frame_config config)
|
|
9
|
-
: struct_buffer{config, nullptr, 0, 0, false, 0, LOOKING_FOR_START_BYTE, 0, {false, 0, 0}},
|
|
10
|
-
parser_result_{config, false, 0, 0, false, {0, 0}} {}
|
|
11
|
-
|
|
12
|
-
void RunRx() {
|
|
13
|
-
uint8_t *buffer;
|
|
14
|
-
size_t buffer_size;
|
|
15
|
-
GetArray(buffer, buffer_size);
|
|
16
|
-
if (buffer && buffer_size) {
|
|
17
|
-
while (!parser_result_.finished) {
|
|
18
|
-
if (parse_buffer(buffer, buffer_size, &parser_result_)) {
|
|
19
|
-
if (parser_result_.valid) {
|
|
20
|
-
HandleResult();
|
|
21
|
-
}
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
void RunTx() { PutArray(struct_buffer::data, struct_buffer::max_size, struct_buffer::size); }
|
|
28
|
-
|
|
29
|
-
protected:
|
|
30
|
-
void Init() { PutArray(struct_buffer::data, struct_buffer::max_size, 0); }
|
|
31
|
-
|
|
32
|
-
// Put Array must accept the full buffer of data and returns a pointer to either a new buffer or the same buffer
|
|
33
|
-
// that is free
|
|
34
|
-
virtual void PutArray(uint8_t *&buffer, size_t &max_length, size_t length) = 0;
|
|
35
|
-
|
|
36
|
-
// Get array, a pointer to an array and refernce to the array length is pased and mutated by this function
|
|
37
|
-
virtual void GetArray(uint8_t *&buffer, size_t &length) = 0;
|
|
38
|
-
|
|
39
|
-
virtual void HandleResult() = 0;
|
|
40
|
-
buffer_parser_result_t parser_result_;
|
|
41
|
-
};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
#pragma once
|
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
#pragma once
|
|
2
|
-
#include "stdint.h"
|
|
3
|
-
#include "struct_frame_gen.h"
|
|
4
|
-
#include "struct_frame_types.h"
|
|
5
|
-
|
|
6
|
-
// https://github.com/serge-sans-paille/frozen
|
|
7
|
-
|
|
8
|
-
static inline bool parse_default_format_validate(uint8_t *data, msg_id_len_t *msg_id_len) {
|
|
9
|
-
(void)data;
|
|
10
|
-
(void)msg_id_len;
|
|
11
|
-
return true;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
static inline bool parse_default_format_char_for_len_id(msg_id_len_t *msg_id_len, const uint8_t c) {
|
|
15
|
-
msg_id_len->msg_id = c;
|
|
16
|
-
msg_id_len->len = get_message_length(c);
|
|
17
|
-
return true;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
parser_functions_t default_parser_functions = {parse_default_format_char_for_len_id, parse_default_format_validate};
|
|
21
|
-
|
|
22
|
-
static inline parser_functions_t *parse_char_for_start_byte(const struct_frame_config config, const uint8_t c) {
|
|
23
|
-
if (config.start_byte == c) {
|
|
24
|
-
return &default_parser_functions;
|
|
25
|
-
}
|
|
26
|
-
return NULL;
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
static inline bool parse_char(struct_buffer *pb, uint8_t c) {
|
|
30
|
-
parser_functions_t *parse_func_ptr = NULL;
|
|
31
|
-
switch (pb->state) {
|
|
32
|
-
case LOOKING_FOR_START_BYTE:
|
|
33
|
-
parse_func_ptr = parse_char_for_start_byte(pb->config, c);
|
|
34
|
-
if (parse_func_ptr) {
|
|
35
|
-
pb->config.parser_funcs = parse_func_ptr;
|
|
36
|
-
pb->state = GETTING_LENGTH_MSG_AND_ID;
|
|
37
|
-
}
|
|
38
|
-
break;
|
|
39
|
-
|
|
40
|
-
case GETTING_LENGTH_MSG_AND_ID:
|
|
41
|
-
if (pb->config.parser_funcs->get_msg_id_len(&pb->msg_id_len, c)) {
|
|
42
|
-
pb->state = GETTING_PAYLOAD;
|
|
43
|
-
pb->size = 0;
|
|
44
|
-
}
|
|
45
|
-
break;
|
|
46
|
-
|
|
47
|
-
case GETTING_PAYLOAD:
|
|
48
|
-
pb->data[pb->size++] = c;
|
|
49
|
-
if (pb->size >= pb->msg_id_len.len) {
|
|
50
|
-
pb->state = LOOKING_FOR_START_BYTE;
|
|
51
|
-
return pb->config.parser_funcs->validate_packet(pb->data, &pb->msg_id_len);
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
break;
|
|
55
|
-
|
|
56
|
-
default:
|
|
57
|
-
break;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
return false;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
static inline bool parse_buffer(uint8_t *buffer, size_t size, buffer_parser_result_t *parser_result) {
|
|
64
|
-
enum ParserState state = LOOKING_FOR_START_BYTE;
|
|
65
|
-
parser_functions_t *parse_func_ptr;
|
|
66
|
-
parser_result->finished = false;
|
|
67
|
-
for (size_t i = parser_result->r_loc; i < size; i++) {
|
|
68
|
-
switch (state) {
|
|
69
|
-
case LOOKING_FOR_START_BYTE:
|
|
70
|
-
parse_func_ptr = parse_char_for_start_byte(parser_result->config, buffer[i]);
|
|
71
|
-
if (parse_func_ptr) {
|
|
72
|
-
state = GETTING_LENGTH_MSG_AND_ID;
|
|
73
|
-
}
|
|
74
|
-
break;
|
|
75
|
-
|
|
76
|
-
case GETTING_LENGTH_MSG_AND_ID:
|
|
77
|
-
if (parse_func_ptr->get_msg_id_len(&parser_result->msg_id_len, buffer[i])) {
|
|
78
|
-
state = GETTING_PAYLOAD;
|
|
79
|
-
}
|
|
80
|
-
break;
|
|
81
|
-
|
|
82
|
-
case GETTING_PAYLOAD:
|
|
83
|
-
parser_result->msg_loc = buffer + i;
|
|
84
|
-
parser_result->r_loc = i + parser_result->msg_id_len.len;
|
|
85
|
-
if (parse_func_ptr->validate_packet(parser_result->msg_loc, &parser_result->msg_id_len)) {
|
|
86
|
-
parser_result->valid = true;
|
|
87
|
-
return true;
|
|
88
|
-
} else {
|
|
89
|
-
parser_result->valid = false;
|
|
90
|
-
return true;
|
|
91
|
-
}
|
|
92
|
-
break;
|
|
93
|
-
|
|
94
|
-
default:
|
|
95
|
-
break;
|
|
96
|
-
}
|
|
97
|
-
}
|
|
98
|
-
parser_result->finished = true;
|
|
99
|
-
parser_result->r_loc = 0;
|
|
100
|
-
return false;
|
|
101
|
-
}
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
#pragma once
|
|
2
|
-
|
|
3
|
-
#include "stdbool.h"
|
|
4
|
-
#include "stdint.h"
|
|
5
|
-
|
|
6
|
-
typedef struct _msg_id_len_t {
|
|
7
|
-
bool valid;
|
|
8
|
-
uint8_t len;
|
|
9
|
-
uint8_t msg_id;
|
|
10
|
-
} msg_id_len_t;
|
|
11
|
-
|
|
12
|
-
typedef struct _parser_functions_t {
|
|
13
|
-
bool (*get_msg_id_len)(msg_id_len_t *, uint8_t);
|
|
14
|
-
bool (*validate_packet)(uint8_t *, msg_id_len_t *);
|
|
15
|
-
} parser_functions_t;
|
|
16
|
-
|
|
17
|
-
typedef struct _struct_frame_config {
|
|
18
|
-
uint8_t has_crc;
|
|
19
|
-
uint8_t has_len;
|
|
20
|
-
uint8_t start_byte;
|
|
21
|
-
parser_functions_t *parser_funcs;
|
|
22
|
-
} struct_frame_config;
|
|
23
|
-
|
|
24
|
-
enum ParserState { LOOKING_FOR_START_BYTE = 0, GETTING_LENGTH_MSG_AND_ID = 1, GETTING_PAYLOAD = 2 };
|
|
25
|
-
|
|
26
|
-
typedef struct _struct_frame_buffer {
|
|
27
|
-
// Used for framing and parsing
|
|
28
|
-
struct_frame_config config;
|
|
29
|
-
uint8_t *data;
|
|
30
|
-
size_t max_size;
|
|
31
|
-
size_t size;
|
|
32
|
-
bool in_progress;
|
|
33
|
-
|
|
34
|
-
// Used for framing
|
|
35
|
-
size_t crc_start_loc;
|
|
36
|
-
|
|
37
|
-
// Used for parsing
|
|
38
|
-
enum ParserState state;
|
|
39
|
-
size_t payload_len;
|
|
40
|
-
msg_id_len_t msg_id_len;
|
|
41
|
-
|
|
42
|
-
} struct_buffer;
|
|
43
|
-
|
|
44
|
-
typedef struct _buffer_parser_result_t {
|
|
45
|
-
struct_frame_config config;
|
|
46
|
-
bool valid;
|
|
47
|
-
uint8_t *msg_loc;
|
|
48
|
-
size_t r_loc;
|
|
49
|
-
bool finished;
|
|
50
|
-
msg_id_len_t msg_id_len;
|
|
51
|
-
} buffer_parser_result_t;
|
|
52
|
-
|
|
53
|
-
// https://github.com/serge-sans-paille/frozen
|
|
54
|
-
// https://www.npmjs.com/package/typed-struct
|
|
55
|
-
|
|
56
|
-
#define default_parser {0, 0, 0x90}
|
|
57
|
-
|
|
58
|
-
#define zero_initialized_parser_result {default_parser, false, 0, 0, false, {0, 0}}
|
|
59
|
-
|
|
60
|
-
#define CREATE_DEFAULT_STRUCT_BUFFER(name, size) \
|
|
61
|
-
uint8_t name##_buffer[size]; \
|
|
62
|
-
struct_buffer name = {default_parser, name##_buffer, size, 0, false, 0, LOOKING_FOR_START_BYTE, 0, {false, 0, 0}};
|
|
63
|
-
|
|
64
|
-
typedef struct checksum_t {
|
|
65
|
-
uint8_t byte1;
|
|
66
|
-
uint8_t byte2;
|
|
67
|
-
} checksum_t;
|
|
File without changes
|
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
from enum import Enum
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
def fletcher_checksum_calculation(buffer, start=0, end=None):
|
|
6
|
-
if end == None:
|
|
7
|
-
end = len(buffer)
|
|
8
|
-
|
|
9
|
-
byte1 = 0
|
|
10
|
-
byte2 = 0
|
|
11
|
-
|
|
12
|
-
for x in range(start, end):
|
|
13
|
-
byte1 += buffer[x]
|
|
14
|
-
byte2 += byte1
|
|
15
|
-
|
|
16
|
-
return [byte1, byte2]
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
class BasicPacket:
|
|
20
|
-
start_byte = 0x90
|
|
21
|
-
header_length = 0
|
|
22
|
-
footer_length = 0
|
|
23
|
-
|
|
24
|
-
desired_packet_length = 0
|
|
25
|
-
packet = []
|
|
26
|
-
|
|
27
|
-
def __init__(self, start_byte=0x90, header_length=2, footer_length=2):
|
|
28
|
-
self.start_byte = start_byte
|
|
29
|
-
self.header_length = header_length
|
|
30
|
-
self.footer_length = footer_length
|
|
31
|
-
|
|
32
|
-
def add_header_byte(self, byte, clear=False):
|
|
33
|
-
if clear:
|
|
34
|
-
self.packet.clear()
|
|
35
|
-
self.packet.append(byte)
|
|
36
|
-
return len(self.packet) == self.header_length
|
|
37
|
-
|
|
38
|
-
def add_packet_byte(self, byte):
|
|
39
|
-
self.packet.append(byte)
|
|
40
|
-
return len(self.packet) == self.desired_packet_length
|
|
41
|
-
|
|
42
|
-
def get_msg_id(self):
|
|
43
|
-
return self.packet[1]
|
|
44
|
-
|
|
45
|
-
def get_full_packet_length(self, msg_length):
|
|
46
|
-
self.desired_packet_length = self.header_length + self.footer_length + msg_length
|
|
47
|
-
return self.desired_packet_length
|
|
48
|
-
|
|
49
|
-
def validate_packet(self):
|
|
50
|
-
checksum = fletcher_checksum_calculation(
|
|
51
|
-
self.packet, self.header_length, self.desired_packet_length - self.footer_length)
|
|
52
|
-
return checksum[0] == self.packet[-2] and checksum[1] == self.packet[-1]
|
|
53
|
-
|
|
54
|
-
def get_msg_buffer(self):
|
|
55
|
-
return self.packet[self.header_length:self.desired_packet_length - self.footer_length]
|
|
56
|
-
|
|
57
|
-
def encode_msg(self, msg):
|
|
58
|
-
return self.encode(msg.pack(), msg.msg_id)
|
|
59
|
-
|
|
60
|
-
def encode(self, data, msg_id):
|
|
61
|
-
output = []
|
|
62
|
-
output.append(self.start_byte)
|
|
63
|
-
output.append(msg_id)
|
|
64
|
-
if (len(data)):
|
|
65
|
-
for b in data:
|
|
66
|
-
output.append(b)
|
|
67
|
-
checksum = fletcher_checksum_calculation(data)
|
|
68
|
-
|
|
69
|
-
output.append(checksum[0])
|
|
70
|
-
output.append(checksum[1])
|
|
71
|
-
return output
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
class ParserState(Enum):
|
|
75
|
-
LOOKING_FOR_START_BYTE = 0
|
|
76
|
-
GETTING_HEADER = 1
|
|
77
|
-
GETTING_PACKET = 2
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
class FrameParser:
|
|
81
|
-
state = ParserState.LOOKING_FOR_START_BYTE
|
|
82
|
-
buffer = []
|
|
83
|
-
packetFormat = None
|
|
84
|
-
msg_definitions = None
|
|
85
|
-
msg_id_loc = None
|
|
86
|
-
msg_type = None
|
|
87
|
-
|
|
88
|
-
def __init__(self, packetFormats, msg_definitions):
|
|
89
|
-
self.packetFormats = packetFormats
|
|
90
|
-
self.msg_definitions = msg_definitions
|
|
91
|
-
|
|
92
|
-
def parse_char(self, c):
|
|
93
|
-
if self.state == ParserState.LOOKING_FOR_START_BYTE:
|
|
94
|
-
self.packetFormat = self.packetFormats[c]
|
|
95
|
-
if self.packetFormat:
|
|
96
|
-
if self.packetFormat.add_header_byte(c, True):
|
|
97
|
-
self.state = ParserState.GETTING_PACKET
|
|
98
|
-
else:
|
|
99
|
-
self.state = ParserState.GETTING_HEADER
|
|
100
|
-
|
|
101
|
-
elif self.state == ParserState.GETTING_HEADER:
|
|
102
|
-
if self.packetFormat.add_header_byte(c):
|
|
103
|
-
msg_id = self.packetFormat.get_msg_id()
|
|
104
|
-
self.msg_type = self.msg_definitions[msg_id]
|
|
105
|
-
if self.msg_type:
|
|
106
|
-
self.packetFormat.get_full_packet_length(
|
|
107
|
-
self.msg_type.msg_size)
|
|
108
|
-
self.state = ParserState.GETTING_PACKET
|
|
109
|
-
else:
|
|
110
|
-
self.state = ParserState.LOOKING_FOR_START_BYTE
|
|
111
|
-
|
|
112
|
-
elif self.state == ParserState.GETTING_PACKET:
|
|
113
|
-
if self.packetFormat.add_packet_byte(c):
|
|
114
|
-
self.state = ParserState.LOOKING_FOR_START_BYTE
|
|
115
|
-
if self.packetFormat.validate_packet():
|
|
116
|
-
return self.msg_type.create_unpack(bytes(self.packetFormat.get_msg_buffer()))
|
|
117
|
-
|
|
118
|
-
return False
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
import { Struct } from 'typed-struct';
|
|
2
|
-
import * as sf_types from './struct_frame_types';
|
|
3
|
-
|
|
4
|
-
function fletcher_checksum_calculation(buffer: Uint8Array, data_length: number): sf_types.checksum_t {
|
|
5
|
-
const checksum: sf_types.checksum_t = { byte1: 0, byte2: 0 };
|
|
6
|
-
|
|
7
|
-
for (let i = 0; i < data_length; i++) {
|
|
8
|
-
checksum.byte1 += buffer[i];
|
|
9
|
-
checksum.byte2 += checksum.byte1;
|
|
10
|
-
}
|
|
11
|
-
return checksum;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export function msg_encode(buffer: sf_types.struct_frame_buffer, msg: any, msgid: number) {
|
|
15
|
-
buffer.data[buffer.size++] = buffer.config.start_byte;
|
|
16
|
-
buffer.crc_start_loc = buffer.size;
|
|
17
|
-
buffer.data[buffer.size++] = msgid;
|
|
18
|
-
|
|
19
|
-
if (buffer.config.has_len) {
|
|
20
|
-
buffer.data[buffer.size++] = msg.getSize();
|
|
21
|
-
}
|
|
22
|
-
const rawData = Struct.raw(msg);
|
|
23
|
-
for (let i = 0; i < rawData.length; i++) {
|
|
24
|
-
buffer.data[buffer.size++] = rawData[i]
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
if (buffer.config.has_crc) {
|
|
28
|
-
const crc = fletcher_checksum_calculation(buffer.data.slice(buffer.crc_start_loc), buffer.crc_start_loc + rawData.length);
|
|
29
|
-
buffer.data[buffer.size++] = crc.byte1;
|
|
30
|
-
buffer.data[buffer.size++] = crc.byte2;
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
export function msg_reserve(buffer: sf_types.struct_frame_buffer, msg_id: number, msg_size: number) {
|
|
35
|
-
throw new Error('Function Unimplemented');
|
|
36
|
-
|
|
37
|
-
if (buffer.in_progress) {
|
|
38
|
-
return;
|
|
39
|
-
}
|
|
40
|
-
buffer.in_progress = true;
|
|
41
|
-
buffer.data[buffer.size++] = buffer.config.start_byte;
|
|
42
|
-
|
|
43
|
-
buffer.data[buffer.size++] = msg_id;
|
|
44
|
-
if (buffer.config.has_len) {
|
|
45
|
-
buffer.data[buffer.size++] = msg_size;
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
const ret = Buffer.from(buffer.data, buffer.size, msg_size);
|
|
49
|
-
buffer.size += msg_size;
|
|
50
|
-
return ret;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
export function msg_finish(buffer: sf_types.struct_frame_buffer) {
|
|
56
|
-
throw new Error('Function Unimplemented');
|
|
57
|
-
|
|
58
|
-
if (buffer.config.has_crc) {
|
|
59
|
-
const crc = fletcher_checksum_calculation(buffer.data.slice(buffer.crc_start_loc), buffer.crc_start_loc - buffer.size);
|
|
60
|
-
buffer.data[buffer.size++] = crc.byte1;
|
|
61
|
-
buffer.data[buffer.size++] = crc.byte2;
|
|
62
|
-
buffer.size += 2
|
|
63
|
-
}
|
|
64
|
-
buffer.in_progress = false;
|
|
65
|
-
}
|
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
import { get_message_length } from './struct_frame_gen';
|
|
2
|
-
import * as sf_types from './struct_frame_types';
|
|
3
|
-
|
|
4
|
-
function parse_default_format_validate(buffer: Uint8Array, msg_id_len: sf_types.msg_id_len_t): boolean {
|
|
5
|
-
return true;
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
function parse_default_format_char_for_len_id(c: number, msg_id_len: sf_types.msg_id_len_t): boolean {
|
|
9
|
-
msg_id_len.msg_id = c;
|
|
10
|
-
msg_id_len.len = get_message_length(c);
|
|
11
|
-
return true;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
const default_parser_functions: sf_types.parser_functions_t = { get_msg_id_len: parse_default_format_char_for_len_id, validate_packet: parse_default_format_validate };
|
|
15
|
-
|
|
16
|
-
function parse_char_for_start_byte(config: sf_types.struct_frame_config, c: number): sf_types.parser_functions_t | undefined {
|
|
17
|
-
if (config.start_byte == c) {
|
|
18
|
-
return default_parser_functions;
|
|
19
|
-
}
|
|
20
|
-
return;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
export function parse_char(pb: sf_types.struct_frame_buffer, c: number): boolean {
|
|
24
|
-
let parse_func_ptr: sf_types.parser_functions_t | undefined = undefined;
|
|
25
|
-
switch (pb.state) {
|
|
26
|
-
case sf_types.ParserState.LOOKING_FOR_START_BYTE:
|
|
27
|
-
parse_func_ptr = parse_char_for_start_byte(pb.config, c);
|
|
28
|
-
if (parse_func_ptr) {
|
|
29
|
-
pb.config.parser_funcs = parse_func_ptr;
|
|
30
|
-
pb.state = sf_types.ParserState.GETTING_LENGTH_MSG_AND_ID;
|
|
31
|
-
}
|
|
32
|
-
break;
|
|
33
|
-
|
|
34
|
-
case sf_types.ParserState.GETTING_LENGTH_MSG_AND_ID:
|
|
35
|
-
if (pb.config.parser_funcs && pb.config.parser_funcs.get_msg_id_len(c, pb.msg_id_len)) {
|
|
36
|
-
pb.state = sf_types.ParserState.GETTING_PAYLOAD;
|
|
37
|
-
pb.size = 0;
|
|
38
|
-
}
|
|
39
|
-
break;
|
|
40
|
-
|
|
41
|
-
case sf_types.ParserState.GETTING_PAYLOAD:
|
|
42
|
-
pb.data[pb.size] = c;
|
|
43
|
-
pb.size++;
|
|
44
|
-
if (pb.size >= pb.msg_id_len.len) {
|
|
45
|
-
pb.msg_data = Buffer.from(pb.data, 0, pb.size)
|
|
46
|
-
pb.state = sf_types.ParserState.LOOKING_FOR_START_BYTE;
|
|
47
|
-
if (pb.config.parser_funcs) {
|
|
48
|
-
return pb.config.parser_funcs.validate_packet(pb.data, pb.msg_id_len);
|
|
49
|
-
}
|
|
50
|
-
return false;
|
|
51
|
-
}
|
|
52
|
-
break;
|
|
53
|
-
|
|
54
|
-
default:
|
|
55
|
-
break;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
return false;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
export function parse_buffer(buffer: Uint8Array, size: number, parser_result: sf_types.buffer_parser_result_t): boolean {
|
|
62
|
-
let state: sf_types.ParserState = sf_types.ParserState.LOOKING_FOR_START_BYTE;
|
|
63
|
-
let parse_func_ptr: sf_types.parser_functions_t | undefined;
|
|
64
|
-
for (let i = parser_result.r_loc; i < size; i++) {
|
|
65
|
-
switch (state) {
|
|
66
|
-
case sf_types.ParserState.LOOKING_FOR_START_BYTE:
|
|
67
|
-
parse_func_ptr = parse_char_for_start_byte(parser_result.config, buffer[i]);
|
|
68
|
-
if (parse_func_ptr) {
|
|
69
|
-
state = sf_types.ParserState.GETTING_LENGTH_MSG_AND_ID;
|
|
70
|
-
}
|
|
71
|
-
break;
|
|
72
|
-
|
|
73
|
-
case sf_types.ParserState.GETTING_LENGTH_MSG_AND_ID:
|
|
74
|
-
if (parse_func_ptr && parse_func_ptr.get_msg_id_len(buffer[i], parser_result.msg_id_len)) {
|
|
75
|
-
state = sf_types.ParserState.GETTING_PAYLOAD;
|
|
76
|
-
}
|
|
77
|
-
break;
|
|
78
|
-
|
|
79
|
-
case sf_types.ParserState.GETTING_PAYLOAD:
|
|
80
|
-
parser_result.msg_data = Buffer.from(buffer, i, (i + parser_result.msg_id_len.len));
|
|
81
|
-
parser_result.r_loc = i + parser_result.msg_id_len.len;
|
|
82
|
-
parser_result.found = true;
|
|
83
|
-
if (parse_func_ptr && parse_func_ptr.validate_packet(parser_result.msg_data, parser_result.msg_id_len)) {
|
|
84
|
-
parser_result.valid = true;
|
|
85
|
-
return true;
|
|
86
|
-
}
|
|
87
|
-
else {
|
|
88
|
-
parser_result.valid = false;
|
|
89
|
-
return true;
|
|
90
|
-
}
|
|
91
|
-
break;
|
|
92
|
-
|
|
93
|
-
default:
|
|
94
|
-
break;
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
return false;
|
|
98
|
-
}
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
export class msg_id_len_t {
|
|
3
|
-
valid = false;
|
|
4
|
-
len = 0;
|
|
5
|
-
msg_id = 0;
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
export type GetMsgIdLenType = (c: number, msg_id_len: msg_id_len_t) => boolean;
|
|
9
|
-
export type ValidatePacketType = (buffer: Uint8Array, msg_id_len: msg_id_len_t) => boolean;
|
|
10
|
-
|
|
11
|
-
export interface parser_functions_t {
|
|
12
|
-
get_msg_id_len: GetMsgIdLenType;
|
|
13
|
-
validate_packet: ValidatePacketType;
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
export interface struct_frame_config {
|
|
17
|
-
has_crc: number;
|
|
18
|
-
has_len: number;
|
|
19
|
-
start_byte: number;
|
|
20
|
-
parser_funcs?: parser_functions_t;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
export enum ParserState {
|
|
24
|
-
LOOKING_FOR_START_BYTE = 0,
|
|
25
|
-
GETTING_LENGTH_MSG_AND_ID = 1,
|
|
26
|
-
GETTING_PAYLOAD = 2
|
|
27
|
-
};
|
|
28
|
-
|
|
29
|
-
export const basic_frame_config: struct_frame_config = { has_crc: 0, has_len: 0, start_byte: 0x90 };
|
|
30
|
-
|
|
31
|
-
export class struct_frame_buffer {
|
|
32
|
-
// Used for framing and parsing
|
|
33
|
-
config: struct_frame_config = basic_frame_config;
|
|
34
|
-
data: Uint8Array;
|
|
35
|
-
size = 0;
|
|
36
|
-
in_progress = false;
|
|
37
|
-
|
|
38
|
-
// Used for framing
|
|
39
|
-
crc_start_loc = 0;
|
|
40
|
-
|
|
41
|
-
// Used for parsing
|
|
42
|
-
state: ParserState = ParserState.LOOKING_FOR_START_BYTE;
|
|
43
|
-
payload_len = 0;
|
|
44
|
-
msg_id_len: msg_id_len_t = new msg_id_len_t();
|
|
45
|
-
msg_data: Buffer = Buffer.allocUnsafe(0);
|
|
46
|
-
|
|
47
|
-
constructor(public max_size: number, buffer?: Uint8Array) {
|
|
48
|
-
if (buffer) {
|
|
49
|
-
this.data = buffer;
|
|
50
|
-
} else {
|
|
51
|
-
this.data = new Uint8Array(max_size);
|
|
52
|
-
}
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
export class buffer_parser_result_t {
|
|
57
|
-
config: struct_frame_config = basic_frame_config;
|
|
58
|
-
found = false;
|
|
59
|
-
valid = false;
|
|
60
|
-
msg_data: Buffer = Buffer.allocUnsafe(0);
|
|
61
|
-
r_loc = 0;
|
|
62
|
-
finished = false;
|
|
63
|
-
msg_id_len: msg_id_len_t = new msg_id_len_t();
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
// https://github.com/serge-sans-paille/frozen
|
|
67
|
-
// https://www.npmjs.com/package/typed-struct
|
|
68
|
-
|
|
69
|
-
//#define default_parser { 0, 0, 0x90 }
|
|
70
|
-
//
|
|
71
|
-
//#define zero_initialized_parser_result { default_parser, false, false, 0, 0, false, { 0, 0} };
|
|
72
|
-
//
|
|
73
|
-
//#define CREATE_DEFAULT_STRUCT_BUFFER(name, size) \
|
|
74
|
-
// uint8_t name##_buffer[size]; \
|
|
75
|
-
// struct_buffer name = { default_parser, name##_buffer, size, 0, 0, false, 0, 0, 0, 0, NULL }
|
|
76
|
-
|
|
77
|
-
export interface checksum_t {
|
|
78
|
-
byte1: number;
|
|
79
|
-
byte2: number;
|
|
80
|
-
}
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: struct-frame
|
|
3
|
-
Version: 0.0.25
|
|
4
|
-
Summary: A framework for serializing data with headers
|
|
5
|
-
Project-URL: Homepage, https://github.com/mylonics/struct-frame
|
|
6
|
-
Project-URL: Issues, https://github.com/mylonics/struct-frame/issues
|
|
7
|
-
Author-email: Rijesh Augustine <rijesh@mylonics.com>
|
|
8
|
-
License-Expression: MIT
|
|
9
|
-
License-File: LICENSE
|
|
10
|
-
Classifier: Operating System :: OS Independent
|
|
11
|
-
Classifier: Programming Language :: Python :: 3
|
|
12
|
-
Requires-Python: >=3.8
|
|
13
|
-
Requires-Dist: proto-schema-parser>=1.4.5
|
|
14
|
-
Requires-Dist: structured-classes>=3.1.0
|
|
15
|
-
Description-Content-Type: text/markdown
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
TS install
|
|
20
|
-
|
|
21
|
-
npm i -D typescript typed-struct @types/node
|
|
22
|
-
npx tsc --init
|
|
23
|
-
npx tsc index.ts
|
|
24
|
-
node index.js
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
npx tsc --project tsconfig.json; node index.js
|
|
28
|
-
|
|
29
|
-
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
struct_frame/__init__.py,sha256=6v6MeHXVPlCn-sXE23fbGHqz8VA_xqCab8yeJ61-Njo,327
|
|
2
|
-
struct_frame/__main__.py,sha256=tIybnBeFHvwiwVhodVOSnxhne5AX_80mtXBx4rneSB4,143
|
|
3
|
-
struct_frame/base.py,sha256=1Z_0vMkwz0X8r2hIVLv5yuhwwD929LwNMzVKBqFxxac,2012
|
|
4
|
-
struct_frame/c_gen.py,sha256=dQw52Zgec38O471KaHuYkRyehcxfjmSOpvhppExgB1c,5969
|
|
5
|
-
struct_frame/generate.py,sha256=vhBAvhFuDAvJdPXaYvdNTcMJeoirlnhc8NsVp0Gls7Q,12598
|
|
6
|
-
struct_frame/py_gen.py,sha256=ZdfLWK7z_tayNW5zAKVSQMCHzw5Q8UEtxZNbJuPQZBw,4052
|
|
7
|
-
struct_frame/ts_gen.py,sha256=qdJgAMxL2lV_WmGZErjHpgukYHNNpKpECarXdfmngEI,6266
|
|
8
|
-
struct_frame/boilerplate/c/struct_frame.h,sha256=sVJtzKsA5H6irH_dTdbVmiL0A74cG8AhzO37xSlANzo,5074
|
|
9
|
-
struct_frame/boilerplate/c/struct_frame_cpp.h,sha256=S6KEgeW78TGVeGGRuTseTXwkMNtzFT-n7faRg3A6nfo,1387
|
|
10
|
-
struct_frame/boilerplate/c/struct_frame_gen.h,sha256=rsuYGesEv1rWzSU1z6ybG-1e95RuVR7_IiR1mGLhYpQ,14
|
|
11
|
-
struct_frame/boilerplate/c/struct_frame_parser.h,sha256=5WP-0fH8BbqTeRUdzAye0Qh6gPBNHwVUocB3-gn5MOE,3005
|
|
12
|
-
struct_frame/boilerplate/c/struct_frame_types.h,sha256=5aJUQ_cbVPM9drdRfo1gmN46-PiAtICAZYrpVjmHaJA,1684
|
|
13
|
-
struct_frame/boilerplate/py/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
14
|
-
struct_frame/boilerplate/py/struct_frame_parser.py,sha256=TGGvVylzqKpiPAAG06eBUHqSQBzwuvAXiSpDi5m0Yd0,3789
|
|
15
|
-
struct_frame/boilerplate/ts/struct_frame.ts,sha256=botKdIKVP7Bi6BJdXfIZaGAmoATnuj54LxZxc4DAWqM,2252
|
|
16
|
-
struct_frame/boilerplate/ts/struct_frame_gen.ts,sha256=KAZitCUBeE8k0LSYLfOvR1GfG9JWDJUEDtmAOvOUAX0,168
|
|
17
|
-
struct_frame/boilerplate/ts/struct_frame_parser.ts,sha256=6eTbafomqTsX3Fvfn82rxNQMxu4PwTaPug38xw4wrhE,3523
|
|
18
|
-
struct_frame/boilerplate/ts/struct_frame_types.ts,sha256=aBtxVI2lUJKGPTtJAOpbStpS2sXSKvd4XWCIsOnaMk8,2130
|
|
19
|
-
struct_frame-0.0.25.dist-info/METADATA,sha256=g8s0pxX1XU8picrrHIxGdisb5isILnHxyfzugbluRKA,745
|
|
20
|
-
struct_frame-0.0.25.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
|
21
|
-
struct_frame-0.0.25.dist-info/licenses/LICENSE,sha256=UjbLtGfcHCIqJg9UzEVGoNW8fyX4Ah9ZbsuAmJ_vhmk,1094
|
|
22
|
-
struct_frame-0.0.25.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|