From 0f0afb72a1d92a77337f8fe920ea800cf5693a07 Mon Sep 17 00:00:00 2001 From: Sara Date: Wed, 13 Sep 2023 15:08:26 +0000 Subject: [PATCH 1/6] Added README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5e513e0 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Kwil Header tool +An in-development command line tool for generating serialization code from C header files. + +Features: +[x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()` +[ ] Generate `*_from_json` functins for structs. +[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=`) + +## Example +```c +#include "kwil.h" // kwil.h header contains empty KWIL_STRUCT() KWIL_ENUM() and KWIL_FIELD() macros + +``` \ No newline at end of file -- 2.34.1 From d2c96f2f742fbabc5f23a52b5a8c75910abdfd94 Mon Sep 17 00:00:00 2001 From: Sara Date: Wed, 13 Sep 2023 19:05:10 +0000 Subject: [PATCH 2/6] Update 'README.md' --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index 5e513e0..d3725c8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,8 @@ # Kwil Header tool + An in-development command line tool for generating serialization code from C header files. Features: [x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()` [ ] Generate `*_from_json` functins for structs. [ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=`) - -## Example -```c -#include "kwil.h" // kwil.h header contains empty KWIL_STRUCT() KWIL_ENUM() and KWIL_FIELD() macros - -``` \ No newline at end of file -- 2.34.1 From dda4f9b7d913653044b9097dbd2ac15b981a6c57 Mon Sep 17 00:00:00 2001 From: Sara Date: Wed, 13 Sep 2023 19:05:27 +0000 Subject: [PATCH 3/6] Update 'README.md' --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d3725c8..078ec5d 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ An in-development command line tool for generating serialization code from C header files. Features: + [x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()` + [ ] Generate `*_from_json` functins for structs. + [ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=`) -- 2.34.1 From 9546b128cbc6fb788f57d7db755a68e1ead74adf Mon Sep 17 00:00:00 2001 From: Sara Date: Wed, 13 Sep 2023 19:05:54 +0000 Subject: [PATCH 4/6] Update 'README.md' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 078ec5d..e1524e9 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,6 @@ Features: [x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()` -[ ] Generate `*_from_json` functins for structs. +[ ] Generate `*_from_json` functions for structs. [ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=`) -- 2.34.1 From 833e7bd2b0517e10b9192825c25ef0e1bf3ca12e Mon Sep 17 00:00:00 2001 From: Sara Date: Wed, 13 Sep 2023 19:06:49 +0000 Subject: [PATCH 5/6] Update 'README.md' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e1524e9..f67dd74 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,4 @@ Features: [ ] Generate `*_from_json` functions for structs. -[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=`) +[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=field_length`) -- 2.34.1 From 72e83e4f381a6779eeabd3ddc6888b824daf12a5 Mon Sep 17 00:00:00 2001 From: Sara Date: Thu, 14 Sep 2023 09:19:40 +0000 Subject: [PATCH 6/6] Update 'README.md' --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f67dd74..7200363 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,15 @@ An in-development command line tool for generating serialization code from C header files. +Kwil aims to be a non-intrusive drop-in (and if necessary drop-out) solution to automate the annoying task of writing deserialization and serialization code. + +Currently aiming for json support, though adding (optional) support for other formats is strongly considered for implementing at a later time. + + Features: [x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()` [ ] Generate `*_from_json` functions for structs. -[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=field_length`) +[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=src->field_length`) -- 2.34.1