Skip to content

Update wiki docs to match recent README and CI changes #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ionux merged 1 commit into from
Apr 17, 2026
Merged

Update wiki docs to match recent README and CI changes #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions wiki/API-Reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,26 +64,26 @@ All result/failure codes returned by parse and getter routines:

| Code | Value | Meaning |
|---|---|---|
| `OKJ_SUCCESS` | 0 | Successful operation |
| `OKJ_ERROR_INVALID_CHARACTER` | 1 | Unexpected character encountered |
| `OKJ_ERROR_SYNTAX` | 2 | Structural syntax error |
| `OKJ_SUCCESS` | 0 | Operation succeeded |
| `OKJ_ERROR_INVALID_CHARACTER` | 1 | Unexpected character in input |
| `OKJ_ERROR_SYNTAX` | 2 | Structural syntax error (trailing comma, missing colon, etc.) |
| `OKJ_ERROR_OVERFLOW` | 3 | Internal numeric overflow |
| `OKJ_ERROR_UNEXPECTED_END` | 4 | Input ended prematurely |
| `OKJ_ERROR_MAX_TOKENS_EXCEEDED` | 5 | Token array full (`OKJ_MAX_TOKENS`) |
| `OKJ_ERROR_MAX_STR_LEN_EXCEEDED` | 6 | String exceeds `OKJ_MAX_STRING_LEN` |
| `OKJ_ERROR_BAD_POINTER` | 7 | Unexpected NULL pointer argument |
| `OKJ_ERROR_BAD_NUMBER` | 8 | Malformed numeric literal |
| `OKJ_ERROR_BAD_OBJECT` | 9 | Malformed object |
| `OKJ_ERROR_BAD_STRING` | 10 | Malformed string |
| `OKJ_ERROR_BAD_ARRAY` | 11 | Malformed array |
| `OKJ_ERROR_BAD_BOOLEAN` | 12 | Malformed boolean literal |
| `OKJ_ERROR_NULL_PARSER_OBJ` | 13 | Parser pointer is NULL |
| `OKJ_ERROR_INVALID_TYPE_ENUM` | 14 | Unrecognised `OkJsonType` value |
| `OKJ_ERROR_NO_FREE_SPACE` | 15 | No space left in token array |
| `OKJ_ERROR_UNEXPECTED_END` | 4 | Input ended before all containers were closed |
| `OKJ_ERROR_MAX_TOKENS_EXCEEDED` | 5 | Token array full; input exceeds `OKJ_MAX_TOKENS` |
| `OKJ_ERROR_MAX_STR_LEN_EXCEEDED` | 6 | String or key exceeds `OKJ_MAX_STRING_LEN` bytes |
| `OKJ_ERROR_BAD_POINTER` | 7 | `NULL` pointer passed where a non-`NULL` argument is required |
| `OKJ_ERROR_BAD_NUMBER` | 8 | Key not found or value is not a number |
| `OKJ_ERROR_BAD_OBJECT` | 9 | Key not found, value is not an object, or member count exceeds `OKJ_MAX_OBJECT_SIZE` |
| `OKJ_ERROR_BAD_STRING` | 10 | Key not found or value is not a string |
| `OKJ_ERROR_BAD_ARRAY` | 11 | Key not found, value is not an array, or element count exceeds `OKJ_MAX_ARRAY_SIZE` |
| `OKJ_ERROR_BAD_BOOLEAN` | 12 | Key not found or value is not a boolean |
Comment on lines +75 to +79

@chatgpt-codex-connector chatgpt-codex-connector Bot Apr 17, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document overloaded BAD_ parse meanings*

The shared OkjError table now defines OKJ_ERROR_BAD_NUMBER, OKJ_ERROR_BAD_STRING, and OKJ_ERROR_BAD_BOOLEAN only in getter terms, but okj_parse also returns those codes for malformed literals (as your own parse return table below states). This makes the API reference internally contradictory and can cause callers to mis-handle parser failures as key/type lookup errors; please include both parse and getter semantics (or separate parse/getter meanings) for these overloaded error codes.

Useful? React with 👍 / 👎.

| `OKJ_ERROR_NULL_PARSER_OBJ` | 13 | Parser pointer is `NULL` |
| `OKJ_ERROR_INVALID_TYPE_ENUM` | 14 | Unrecognised `OkJsonType` value encountered |
| `OKJ_ERROR_NO_FREE_SPACE` | 15 | No free slot remaining in the token array |
| `OKJ_ERROR_PARSING_FAILED` | 16 | General parse failure |
| `OKJ_ERROR_MAX_JSON_LEN_EXCEEDED` | 17 | Input exceeds `OKJ_MAX_JSON_LEN` |
| `OKJ_ERROR_MAX_JSON_LEN_EXCEEDED` | 17 | Input exceeds `OKJ_MAX_JSON_LEN` bytes |
| `OKJ_ERROR_MAX_DEPTH_EXCEEDED` | 18 | Nesting exceeds `OKJ_MAX_DEPTH` |
| `OKJ_ERROR_BRACKET_MISMATCH` | 19 | Mismatched opening/closing brackets |
| `OKJ_ERROR_BRACKET_MISMATCH` | 19 | Mismatched opening and closing brackets |

## Compile-time and const limits

Expand Down
4 changes: 3 additions & 1 deletion wiki/Development-and-Testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ The CI workflow (`build-and-test` job) additionally:
- Runs Cppcheck with the MISRA add-on against the test source, publishing results to the GitHub step summary.
- Publishes a gcovr line/branch coverage summary to the GitHub step summary.

A separate `fuzz` CI job compiles `test/fuzz_target.c` with Clang libFuzzer + ASan + UBSan and runs the fuzzer for up to 10 seconds per push/PR.
A separate `fuzz` CI job compiles `test/fuzz_target.c` with Clang libFuzzer + ASan + UBSan and runs the fuzzer for up to 30 seconds per push/PR.

A third `formal-verification` CI job runs Frama-C WP (with `-wp-rte`) inside the official `framac/frama-c:32.0` container to discharge ACSL contracts on a defined set of functions. Results are published to the GitHub step summary. Functions not yet covered by WP proofs (primarily `okj_parse` and `okj_parse_value`) are guarded in the interim by the fuzzer harness and ASan regression tests.

## Extending the project safely

Expand Down
Loading