%% The MIT License %% Copyright (c) 2010 Alisdair Sullivan %% Permission is hereby granted, free of charge, to any person obtaining a copy %% of this software and associated documentation files (the "Software"), to deal %% in the Software without restriction, including without limitation the rights %% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell %% copies of the Software, and to permit persons to whom the Software is %% furnished to do so, subject to the following conditions: %% The above copyright notice and this permission notice shall be included in %% all copies or substantial portions of the Software. %% 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 OR COPYRIGHT HOLDERS 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. -module(jsx). -export([encoder/2, encoder/3]). -export([decoder/2, decoder/3]). %% shims for jsx_to_json, jsx_to_term, jsx_verify -export([to_json/1, to_json/2]). -export([to_term/1, to_term/2]). -export([is_json/1, is_json/2]). %% test handler -ifdef(TEST). -export([init/1, handle_event/2]). -endif. %% various semi-useful types with nowhere else to hang out -type events() :: [event()]. -type event() :: start_object | end_object | start_array | end_array | end_json | {key, list()} | {string, list()} | {integer, integer()} | {float, float()} | {literal, true} | {literal, false} | {literal, null}. %% definition of the opts record for the encoder and decoder -include("../include/jsx_opts.hrl"). -type opts() :: [opt()]. -type opt() :: loose_unicode | escape_forward_slashes | explicit_end | {parser, auto} | {parser, encoder} | {parser, decoder} | {parser, function()}. -type decoder() :: fun((binary()) -> {ok, events()} | {incomplete, decoder()}). -spec decoder(Mod::module(), Args::any()) -> decoder(). -spec decoder(Mod::module(), Args::any(), OptsList::opts()) -> decoder(). decoder(Mod, Args) when is_atom(Mod) -> decoder(Mod, Args, []). decoder(Mod, Args, OptsList) when is_atom(Mod), is_list(OptsList) -> jsx_decoder:decoder(Mod, Args, OptsList). -type encoder() :: fun((list()) -> {ok, events()} | {incomplete, decoder()}). -spec encoder(Mod::module(), Args::any()) -> encoder(). -spec encoder(Mod::module(), Args::any(), OptsList::opts()) -> encoder(). encoder(Mod, Args) when is_atom(Mod) -> encoder(Mod, Args, []). encoder(Mod, Args, OptsList) when is_atom(Mod), is_list(OptsList) -> jsx_encoder:encoder(Mod, Args, OptsList). -spec to_json(Source::binary() | list()) -> binary(). -spec to_json(Source::binary() | list(), Opts::jsx_to_json:opts()) -> binary(). to_json(Source) -> to_json(Source, []). to_json(Source, Opts) -> jsx_to_json:to_json(Source, Opts). -spec to_term(Source::binary() | list()) -> list(). -spec to_term(Source::binary() | list(), Opts::jsx_to_term:opts()) -> list(). to_term(Source) -> to_term(Source, []). to_term(Source, Opts) -> jsx_to_term:to_term(Source, Opts). -spec is_json(Source::binary() | list()) -> true | false. -spec is_json(Source::binary() | list(), Opts::jsx_verify:opts()) -> true | false. is_json(Source) -> is_json(Source, []). is_json(Source, Opts) -> jsx_verify:is_json(Source, Opts). -ifdef(TEST). -include_lib("eunit/include/eunit.hrl"). jsx_decoder_test_() -> jsx_decoder_gen(load_tests(?eunit_test_path)). encoder_decoder_equiv_test_() -> [ {"encoder/decoder equivalency", ?_assert((jsx:decoder(?MODULE, []))( <<"[\"a\", 17, 3.14, true, {\"k\":false}, []]">> ) =:= (jsx:encoder(?MODULE, []))([<<"a">>, 17, 3.14, true, [{<<"k">>, false}], []]) ) } ]. %% test handler init([]) -> []. handle_event(end_json, State) -> lists:reverse([end_json] ++ State); handle_event(Event, State) -> [Event] ++ State. jsx_decoder_gen([]) -> []; jsx_decoder_gen([Test|Rest]) -> Name = proplists:get_value(name, Test), JSON = proplists:get_value(json, Test), JSX = proplists:get_value(jsx, Test), Flags = proplists:get_value(jsx_flags, Test, []), {generator, fun() -> [{Name, ?_assertEqual(decode(JSON, Flags), JSX)}, {Name ++ " (incremental)", ?_assertEqual(incremental_decode(JSON, Flags), JSX) } | jsx_decoder_gen(Rest) ] end}. load_tests(Path) -> %% search the specified directory for any files with the .test ending TestSpecs = filelib:wildcard("*.test", Path), load_tests(TestSpecs, Path, []). load_tests([], _Dir, Acc) -> lists:reverse(Acc); load_tests([Test|Rest], Dir, Acc) -> case file:consult(Dir ++ "/" ++ Test) of {ok, TestSpec} -> ParsedTest = parse_tests(TestSpec, Dir), load_tests(Rest, Dir, [ParsedTest] ++ Acc) ; {error, _Reason} -> erlang:error(badarg, [Test|Rest], Dir, Acc) end. parse_tests(TestSpec, Dir) -> parse_tests(TestSpec, Dir, []). parse_tests([{json, Path}|Rest], Dir, Acc) when is_list(Path) -> case file:read_file(Dir ++ "/" ++ Path) of {ok, Bin} -> parse_tests(Rest, Dir, [{json, Bin}] ++ Acc) ; _ -> erlang:error(badarg, [[{json, Path}|Rest], Dir, Acc]) end; parse_tests([KV|Rest], Dir, Acc) -> parse_tests(Rest, Dir, [KV] ++ Acc); parse_tests([], _Dir, Acc) -> Acc. decode(JSON, Flags) -> try case (gen_json:parser(?MODULE, [], Flags))(JSON) of {incomplete, More} -> case More(<<" ">>) of {incomplete, _} -> {error, badjson} ; Events -> Events end ; Events -> Events end catch error:badarg -> {error, badjson} end. incremental_decode(<>, Flags) -> P = gen_json:parser(?MODULE, [], Flags ++ [explicit_end]), try incremental_decode_loop(P(C), Rest) catch error:badarg -> io:format("~p~n", [erlang:get_stacktrace()]), {error, badjson} end. incremental_decode_loop({incomplete, More}, <<>>) -> case More(end_stream) of {incomplete, _} -> {error, badarg} ; X -> X end; incremental_decode_loop({incomplete, More}, <>) -> incremental_decode_loop(More(C), Rest). -endif.