Skip to content

Commit

Permalink
- initial checkin of WJElement code
Browse files Browse the repository at this point in the history
  • Loading branch information
Owen Swerkstrom committed Aug 17, 2012
1 parent 45063a4 commit 574e703
Show file tree
Hide file tree
Showing 46 changed files with 12,339 additions and 0 deletions.
47 changes: 47 additions & 0 deletions CMakeLists.txt
@@ -0,0 +1,47 @@
project(WJElement)
cmake_minimum_required(VERSION 2.6)
include(CheckIncludeFiles)
include(CheckSymbolExists)

if(NOT CMAKE_INSTALL_PREFIX)
set(CMAKE_INSTALL_PREFIX /usr/local)
endif(NOT CMAKE_INSTALL_PREFIX)
set(INC_DEST_DIR ${CMAKE_INSTALL_PREFIX}/include)
set(LIB_DEST_DIR ${CMAKE_INSTALL_PREFIX}/lib)
set(BIN_DEST_DIR ${CMAKE_INSTALL_PREFIX}/bin)

if(CMAKE_BUILD_TYPE MATCHES Debug)
add_definitions(-DDEBUG)
option(SHOWNOTES "Show preprocessor notes" OFF)

if(CMAKE_COMPILER_IS_GNUCC)
# GCC specific debug options
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O0 -g3 -ggdb3 -gdwarf-2")
set(AVOID_VERSION -avoid-version)
endif(CMAKE_COMPILER_IS_GNUCC)
endif(CMAKE_BUILD_TYPE MATCHES Debug)

add_definitions(-DHAVE_CONFIG_H)

check_include_files(string.h HAVE_STRING_H)
check_symbol_exists(strcasecmp "strings.h" HAVE_STRCASECMP)

set(OPENSSL_LIBS ssl crypto)
set(PTHREAD_LIBS pthread)

# use, i.e. don't skip the full RPATH for the build tree
SET(CMAKE_SKIP_BUILD_RPATH FALSE)
# when building, don't use the install RPATH already
# (but later on when installing)
SET(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
# the RPATH to be used when installing
SET(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
# add the automatically determined parts of the RPATH
# which point to directories outside the build tree to the install RPATH
SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)

ENABLE_TESTING(1)

include_directories(include)
add_subdirectory(src)
add_subdirectory(include)
674 changes: 674 additions & 0 deletions COPYING

Large diffs are not rendered by default.

165 changes: 165 additions & 0 deletions COPYING.LESSER
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
23 changes: 23 additions & 0 deletions README
@@ -0,0 +1,23 @@
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 has grown into a generally-useful library, and is used across
Messaging Architects' netmail and related projects. It is loved enough by
MA's developers that we desire to use it elsewhere too, and we think others
will enjoy it as well. So, here it is, ready to be consumed in any project,
open or closed, as outlined by the GNU LGPL. 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! :^)


Owen Swerkstrom <owens@netmail.com> - community/repository front-man
Micah N Gorrell <micahg@netmail.com> - primary author of WJElement code
149 changes: 149 additions & 0 deletions documentation/index.html
@@ -0,0 +1,149 @@
<html>
<head>
<title>WJElement Documentation: index</title>
</head>
<body>

<h1>About</h1>
<p>
WJElement - JSON 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.
</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>.
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, it should be noted
that there are a few things this library currently does not do particularly
well, or in a generally-useful fashion, or handles in a seemingly-awkward
way...
</p>
<p>
<ul>
<li>
XplBool return values
<ul>
<li>
Many functions return TRUE on success. Deal. :^)
</li>
</ul>
</li>
<li>
Floating-point number values (unimplemented)
<ul>
<li>
WJElement does not support floats, because we don't need them, at least
not yet.
</li>
</ul>
</li>
<li>
Schema validation (useful, incomplete)
<ul>
<li>
"patternProperties" validation is unimplemented; JSON with invalid data in
such a defined property will pass.
</li>
<li>
"format" validation on strings is unimplemented. The json-schema draft
specification allows this to be missing, and so far, so do we.
</li>
<li>
"backlinks"... 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? :^)
</li>
</ul>
<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 back ;^) these features if
you are so inclined. In most 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:owens@netmail.com">
Owen Swerkstrom &lt;owens@netmail.com&gt;
</a> - community/repository front-man, primary WJElementSchema author
</li>
<li>
<a href="mailto:migahg@netmail.com">
Micah N Gorrell &lt;micahg@netmail.com&gt;
</a> - primary WJElement, WJReader, WJWriter author
</li>
</ul>
</p>


</body>
</html>

0 comments on commit 574e703

Please sign in to comment.