Skip to content

TODO.md

Latest commit

 

History

History
50 lines (32 loc) · 2.06 KB

TODO.md

File metadata and controls

50 lines (32 loc) · 2.06 KB

Remaining tasks

Refactor to remove unreachable branches and ensure 100% test coverage in dsdl.c

Review the code in dsdl.c and refactor it such that there are no unreachable or redundant branches. If any such unreachable code is found, refactor it such that the unreachable branches are eliminated, and the remaining valid branch contains an assertion check. For example, given code like:

if (!dsdl_bigint_sub_abs(a, b, out)) {
    assert(false);  // Unreachable, cannot be covered by tests, WRONG!
    return false;
}

Refactor it into:

const bool ok = dsdl_bigint_sub_abs(a, b, out);
assert(ok);  // Reachable, valid!
(void) ok;   // Avoid unused variable warnings in debug builds.

Add new tests to ensure full test coverage. Prefer tests that use the public API only. If there is any code that cannot be tested through the public API, resort to intrusive tests that #include "dsdl.c" directly.

Add nested composite serialization and deserialization tests

Add tests that verify serialization and deserialization of nested composites, including struct nesting struct, struct nesting union, union nestring struct, and union nesting union.

Configure CI to fail if test coverage is too low

CI must require 99% coverage.

Cleanup code

  • Ensure the recommended header inclusion order is followed throughout: dsdl.h first, then the rest.
  • Remove redundant comments, esp. TODO comments that are already addressed.
  • Identify unused entities and eliminate them.
  • Simplify what can be simplified.
  • Eliminate redundancies.

Identify and fix memory leaks

There probably are some memory leaks that need fixing.

Allow NULL value pointers in struct and union

See TODO comments in dsdl.h.

Proper JSON serialization example

examples/serialize_to_json.c must include a recursive function that can serialize an arbitrary data type into JSON, and the name of the type is to be accepted via CLI args. The function will descend the tree and emit each item into JSON. The emission should be done via a callback accepting wkv_str_t instead of direct stdout access.