Merge pull request #13 from quartzjer/v2

Version 2!

Author: quartzjer

.travis.yml

@@ -0,0 +1,5 @@
+language: c
+script: make test
+compiler:
+  - clang
+  - gcc

Makefile

@@ -1,18 +1,22 @@
-MANDIR=/usr/share/man/man3
 
-all: js0n_test example
+all: test example
 
-js0n_test: test/js0n_test.c js0n.c j0g.c
-	gcc -Wall -o js0n_test test/js0n_test.c js0n.c j0g.c
+test.c: test/test.c src/js0n.c
+	gcc -Wall -o test/test test/test.c src/js0n.c
 
-example: test/example.c js0n.c j0g.c
-	gcc -Wall -o example test/example.c js0n.c j0g.c
-
-clean:
-	rm -f example js0n_test
+test: test.c
+	@if ./test/test ; then \
+		rm -f ./test/test; \
+		echo "TESTS PASSED"; \
+	else \
+		rm -f ./test/test; \
+		echo "TESTS FAILED"; exit 1; \
+	fi; \
 
+example: test/example.c src/js0n.c
+	gcc -Wall -o example test/example.c src/js0n.c
 
-man: ${MANDIR}/js0n.3 ${MANDIR}/j0g.3
+clean:
+	rm -f example test/test
 
-${MANDIR}/%.3: %.3
-	sudo cp $? $@
+.PHONY: all test clean

README

@@ -0,0 +1,42 @@
+# js0n - Flexible Zero-Footprint JSON Parser in C
+
+A one-pass minimal overhead walk of the raw bytes, using each one as an index into a jump table to determine state transitions.
+
+* public domain, single js0n.c file with one function
+* easy to use, just returns a given key-value pair location in the JSON string
+* no dependencies, embedded friendly
+* requires no memory/malloc or copying, uses only what is passed in (up to `int` max length)
+* more flexible than strict JSON and allows bare keys (non-validating)
+* optimized for high speed scanning/routing of small chunks of json, stops parsing upon match
+* safely errors on anything really bad (binary, NULLs, etc)
+
+Parsing this:
+
+````json
+{
+    "barbar": [
+        1,
+        2,
+        3
+    ],
+    "foo": "bar",
+    "obj": {
+        "a": "b"
+    }
+}
+
+````
+
+Using `val = js0n("barbar", 6, json, strlen(json), &vlen)` would return a val pointing to `[1,2,3]` and set vlen to `7`.
+
+For arrays, pass `NULL` as the key, and the array offset as the second argument.
+
+When the value is not found `NULL` is returned, if there were any parsing errors then vlen will be set to `-1`.
+
+To determine if the returned value is an actual JSON string or a bare value (like `"true"` vs `true`), simply check if it starts with a quote character via `if(val && *(val-1) == '"')`.
+
+For more usage examples see the [test.json](test/test.json) and [test.c](test/test.c).
+
+## History
+
+See [v1.0](https://github.com/quartzjer/js0n/tree/v1.0) for the original `js0n` function that returned an index of offsets for all key/values in one pass.

README.md

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>