olemorud/json-parser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
olemorud
2023-04-28 18:37:09 +02:00
parent 2f61569ee1
commit dda6bbba42
1 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -7,22 +7,21 @@ Not guaranteed to be safe, reliable or efficient.
## Usage ## Usage
### Compile ### Compile
build (release build): build (release build):
```sh ```sh
make BUILD=release make BUILD=release
``` ```
To make a debug build just run `make`. To make a debug build just run `make`.
### Run ### Run
```sh ```sh
./bin/{release|debug}/json_parser sample.json ./bin/{release|debug}/json_parser sample-files/large-file.json
``` ```
## Limitations
Does not support unicode.
## Implementation ## Implementation
Parsed JSON values are stored as structs containing type information and data. Parsed JSON values are stored as structs containing type information and data.
@@ -38,19 +37,28 @@ struct json_value {
struct json_value** array; struct json_value** array;
char* string; char* string;
bool boolean; bool boolean;
int64_t number; double number;
}; };
}; };
``` ```
### Types ### Types
#### JSON Objects
Object values have the type field set to `(enum json_type) object`
They are stored using a poorly written map implementation with the type `obj_t`
in `json_value.object`
See [obj_t](#obj_t) for more details.
#### JSON Arrays #### JSON Arrays
Array values have the type field set to `(enum json_type) array` Array values have the type field set to `(enum json_type) array`
JSON Arrays are stored as null-terminated `json_value*` arrays, JSON Arrays are stored as null-terminated `json_value*` arrays,
`struct json_value**`, in `json_value.array` i.e. `struct json_value**`, in `json_value.array`
#### JSON Numbers #### JSON Numbers
@@ -82,15 +90,9 @@ The values are stored as `bool` in `json_value.boolean`
Null values have type field set to `(enum json_type) null`. Null values have type field set to `(enum json_type) null`.
#### JSON Objects ### obj\_t
Object values have the type field set to `(enum json_type) object`
They are stored using a poorly written map implementation with the type `obj_t`
in `json_value.object`
##### obj\_t
`obj_t` is defined in `json_value.h` as:
```c ```c
typedef struct obj_entry { typedef struct obj_entry {
char const* key; char const* key;
@@ -101,7 +103,7 @@ typedef struct obj_entry {
typedef __p_obj_entry obj_t[OBJ_SIZE]; // OBJ_SIZE=1024 typedef __p_obj_entry obj_t[OBJ_SIZE]; // OBJ_SIZE=1024
``` ```
##### obj\_t methods #### obj\_t methods
`void* obj_at(obj_t m, char* key)` `void* obj_at(obj_t m, char* key)`
@@ -113,5 +115,5 @@ Insert a key-value pair
`void obj_delete(obj_t m)` `void obj_delete(obj_t m)`
Free memory allocated for object Recursively free memory allocated for object and children objects.