zig-json

Simple JSON (RFC8259 Spec) and JSON5 (JSON5 Spec) parsing library with a focus on a simple, usable API.

Note: The simple and usable part is a WIP :)

Features

Parsing []u8, files, STDIN into JSON objects
Fully supports JSON and JSON5 specifications

Importing

Using Zig Packages

Add the dependency to your build.zig.zon.

zig fetch --save https://codeload.github.com/berdon/zig-json/tar.gz/master

Add the module to your build.zig

// build.zig
//   -> fn build
//      b: *std.Build

const zigJsonDependency = b.dependency("zig-json", .{ .target = target, .optimize = optimize });

// ...

exe.root_module.addImport("json", zigJsonDependency.module("zig-json"));

// usage:
//   const json = @import("json");

Legacy

Clone the repo

mkdir deps
git clone --depth 1 git@github.com:berdon/zig-json.git ./deps/zig-json

Update build.zig

exe.addPackagePath("json", "deps/zig-json/src/main.zig");

Usage

From a `[]u8`

const json = @import("json");

// ...

var gpa = std.heap.GeneralPurposeAllocator(.{}){};
defer std.debug.assert(!gpa.deinit());
const allocator = gpa.allocator();

const value = try json.parse(
    \\{
    \\  "foo": [
    \\    null,
    \\    true,
    \\    false,
    \\    "bar",
    \\    {
    \\      "baz": -13e+37
    \\    }
    \\  ]
    \\}
    , allocator);
const bazObj = value.get("foo").get(4);

bazObj.print(null);
try std.testing.expectEqual(bazObj.get("baz").float(), -13e+37);

defer value.deinit(allocator);

{
  "baz": -130000000000000000000000000000000000000
}%

From STDIN

STDIN

{
  "foo": [
    null,
    true,
    false,
    "bar",
    {
      "baz": -13e+37
    }
  ]
}

const json = @import("json");

// ...

var gpa = std.heap.GeneralPurposeAllocator(.{}){};
defer std.debug.assert(gpa.deinit() == std.heap.Check.ok);
const allocator = gpa.allocator();

const file = std.io.getStdIn();

const value = try parseFile(file, allocator);
errdefer value.deinit(allocator);
defer value.deinit(allocator);

const bazObj = value.get("foo").get(4);

bazObj.print(null);
try std.testing.expectEqual(bazObj.get("baz").float(), -13e+37);

{
  "baz": -130000000000000000000000000000000000000
}%

From a file

testFiles/some.json

{
  "foo": [
    null,
    true,
    false,
    "bar",
    {
      "baz": -13e+37
    }
  ]
}

const json = @import("json");

// ...

var gpa = std.heap.GeneralPurposeAllocator(.{}){};
defer std.debug.assert(gpa.deinit() == std.heap.Check.ok);
const allocator = gpa.allocator();

const file = try std.fs.cwd().openFile("testFiles/some.json", .{});
defer file.close();

const value = try parseFile(file, allocator);
errdefer value.deinit(allocator);
defer value.deinit(allocator);

const bazObj = value.get("foo").get(4);

bazObj.print(null);
try std.testing.expectEqual(bazObj.get("baz").float(), -13e+37);

{
  "baz": -130000000000000000000000000000000000000
}%

JSON5

const json = @import("json");

// ...

var gpa = std.heap.GeneralPurposeAllocator(.{}){};
defer std.debug.assert(!gpa.deinit());
const allocator = gpa.allocator();

const value = try parseJson5(
    \\{
    \\  foo: [
    \\    /* Some
    \\     * multi-line comment
    \\     */ null,
    \\    true,
    \\    false,
    \\    "bar",
    \\    // Single line comment
    \\    {
    \\      baz: -13e+37,
    \\      'nan': NaN,
    \\      inf: +Infinity,
    \\    },
    \\  ],
    \\}
    , allocator);
const bazObj = value.get("foo").get(4);

bazObj.print(null);
try std.testing.expectEqual(bazObj.get("baz").float(), -13e+37);

defer value.deinit(allocator);

{
  "baz": -130000000000000000000000000000000000000
}%

Ownership

The parser returns a *JsonValue that you own and are expected to deinit() and destroy() when done. deinit() handles destroying all children.

API

json.parse([]const u8, std.mem.Allocator) returns a *JsonValue struct.

JsonValue

struct {
    /// The JSON value type
    type: JsonType,

    /// Destructor
    pub fn deinit(self: *JsonValue, allocator: Allocator) void { }

    /// Handy pass-thru to typed get(...) calls
    pub fn get(self: *JsonValue, index: anytype) *JsonValue { }

    /// Handy pass-thru to typed len(...) calls
    pub fn len(self: *JsonValue) usize { }

    /// Returns the string value or panics
    pub fn string(self: *JsonValue) []const u8 { }

    /// Returns the object value or panics
    pub fn object(self: *JsonValue) *JsonObject { }

    /// Returns the integer value or panics
    pub fn integer(self: *JsonValue) i64 { }

    /// Returns the float value or panics
    pub fn float(self: *JsonValue) f64 { }

    /// Returns the array value or panics
    pub fn array(self: *JsonValue) *JsonArray { }

    /// Returns the array value or panics
    pub fn boolean(self: *JsonValue) bool { }

    /// Returns the string value or null
    pub fn stringOrNull(self: *JsonValue) ?[]const u8 { }

    /// Returns the object value or null
    pub fn objectOrNull(self: *JsonValue) ?*JsonObject { }

    /// Returns the integer value or null
    pub fn integerOrNull(self: *JsonValue) ?i64 { }

    /// Returns the float value or null
    pub fn floatOrNull(self: *JsonValue) ?f64 { }

    /// Returns the array value or null
    pub fn arrayOrNull(self: *JsonValue) ?*JsonArray { }

    /// Returns the boolean value or null
    pub fn booleanOrNull(self: *JsonValue) ?bool { }

    /// Print the JSON value
    pub fn print(self: *JsonValue, indent: ?usize) void { }
};

If the JSON schema is known ahead of time, you can chain calls to get(...) to access the nested field you want (through JsonObject and JsonArray). To access the actual value you would call the typed accessors (e.g. integer(), string(), etc).

object() and array() return *JsonObject and *JsonArrays respectively.

JsonType

enum {
    object,
    array,
    string,
    integer,
    float,
    boolean,
    nil
};

JsonObject

struct {
    /// Destructor
    pub fn deinit(self: *JsonObject, allocator: Allocator) void { }

    /// Returns the number of members in the object
    pub fn len(self: *JsonObject) usize { }
    
    /// Whether the map contains the key or not
    pub fn contains(self: *JsonObject, key: []const u8) bool {
        return self.map.contains(key);
    }

    /// Return the value for key or panic
    pub fn get(self: *JsonObject, key: []const u8) *JsonValue { }

    /// Return the value for key or null
    pub fn getOrNull(self: *JsonObject, key: []const u8) ?*JsonValue { }

    /// Returns the JSON object's keys
    pub fn keys(self: *JsonObject) [][]const u8 { }

    /// Print out the JSON object
    /// TODO: Need to handle proper character escaping
    pub fn print(self: *JsonObject, indent: ?usize) void { }
};

JsonArray

struct {
    /// Destructor
    pub fn deinit(self: *JsonArray, allocator: Allocator) void { }

    /// The length of the array
    pub fn len(self: *JsonArray) usize { }

    /// Return the items array directly ¯\_(ツ)_/¯
    pub fn items(self: *JsonArray) []*JsonValue { }

    /// Return the item at the index or panic if exceeding normal bounds
    pub fn get(self: *JsonArray, index: usize) *JsonValue { }

    /// Return the item at the index or null
    pub fn getOrNull(self: *JsonArray, index: usize) ?*JsonValue { }

    /// Return the first item or panic if none
    pub fn first(self: *JsonArray) *JsonValue { }

    /// Return the first item or null
    pub fn firstOrNull(self: *JsonArray) ?*JsonValue { }

    /// Print the JSON array
    pub fn print(self: *JsonArray, indent: ?usize) void { }
};

berdon/zig-json