forked from netmail-open/wjelement
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
140 lines (133 loc) · 3.24 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<html>
<head>
<title>WJElement Documentation: index</title>
</head>
<body>
<h1>About</h1>
<p>
WJElement - <a href="http://json.org/">JSON</a> manipulation in C
</p>
<p>
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.
</p>
<p>
<ul>
<li>
WJReader and WJWriter are optimized for speed and memory-efficiency.
</li>
<li>
WJElement focuses on flexibility and handy features, allowing C code to
manipulate JSON documents with as few statements (fewer, sometimes!) as
JavaScript itself.
<ul>
<li>
WJElement provides complete
<a href="http://json-schema.org/">JSON-schema</a> validation
(draft
<a href="https://tools.ietf.org/html/draft-zyp-json-schema-03">v3</a>
is fully supported; v4 support is working but incomplete).
</li>
</ul>
</li>
</ul>
</p>
<h1>License</h1>
<p>
WJElement and its related libraries may be consumed in any project,
open or closed, as outlined by the
<a href="http://www.gnu.org/licenses/lgpl.txt">GNU Lesser
General Public License</a> (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! :^)
</p>
<h1>API</h1>
<p>
<ul>
<li>
<a href="wjelement.html">
WJElement
</a> - flexible JSON manipulation
</li>
<li>
<a href="wjreader.html">
WJReader
</a> - lightweight JSON reader
</li>
<li>
<a href="wjwriter.html">
WJWriter
</a> - lightweight JSON writer
</li>
</ul>
</p>
<h1>Quirks</h1>
<p>
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:
</p>
<p>
<ul>
<li>
XplBool return values
<ul>
<li>
Many functions return TRUE on success. Deal. :^)
</li>
</ul>
</li>
<li>
Schema "backlink"
<ul>
<li>
This is something we're making use of in netmail, but is not
part of the base <a href="http://json-schema.org/">json-schema spec</a>.
You can safely ignore it (or dig in and use it, why not? :^)
</li>
</ul>
</li>
<li>
Libraries, headers (stubs and #define's)
<ul>
<li>
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.
</li>
<li>
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.
</li>
</ul>
</li>
</li>
</ul>
</p>
<p>
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!
</p>
<h1>Contact</h1>
<p>
<ul>
<li>
<a href="mailto:[email protected]">
Owen Swerkstrom <[email protected]>
</a> - community/repository front-man, WJElementSchema author
</li>
<li>
<a href="mailto:[email protected]">
Micah N Gorrell <[email protected]>
</a> - primary WJElement, WJReader, WJWriter author
</li>
</ul>
</p>
</body>
</html>