WJElement Documentation: index

# About

WJElement - JSON manipulation in C

WJElement is a very flexible JSON library developed by Messaging Architects. It was created for MA's "WARP" webserver, and is built on top of the (also-included) lower-level WJReader and WJWriter libraries.

- WJReader and WJWriter are optimized for speed and memory-efficiency.
- WJElement focuses on flexibility and handy features, allowing C code to manipulate JSON documents with as few statements (fewer, sometimes!) as JavaScript itself.
  - WJElement provides complete JSON-schema validation (draft v3 is fully supported; v4 support is working but incomplete).

# License

WJElement and its related libraries may be consumed in any project, open or closed, as outlined by the GNU Lesser General Public License (any version). Include it as-is and link to it from your code, massage it into your own statically-linked package, or use it in ways we haven't thought of. Read the docs/headers, have fun, and if you use it for something awesome, let us know about it! :^)

# API

- WJElement - flexible JSON manipulation
- WJReader - lightweight JSON reader
- WJWriter - lightweight JSON writer

# Quirks

In the spirit of being upfront, and to help you guage whether WJElement is right for you without asking you to invest too much time, there are a few things to note about this library:

- XplBool return values
  - Many functions return TRUE on success. Deal. :^)
- Schema "backlink"
  - This is something we're making use of in netmail, but is not part of the base json-schema spec. You can safely ignore it (or dig in and use it, why not? :^)
- Libraries, headers (stubs and #define's)
  - Xpl (cross-platform library) provides a consistent set of utility functions within netmail. WJElement uses a subset of these functions and definitions, so they have been included.
  - MemMgr (memory manager) provides optimized, slab-based memory management in netmail; for the sake of a general WJElement release, the MemMgr API simply calls malloc et al.

You are free and encouraged to add and contribute features if you are so inclined. In some cases, there are comments or even empty code blocks, just waiting to be filled in. WJElement is great, but you can make it even better!

# Contact

- Owen Swerkstrom <owens@netmail.com> - community/repository front-man, WJElementSchema author
- Micah N Gorrell <micahg@netmail.com> - primary WJElement, WJReader, WJWriter author