%% 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). %% the core parser api -export([parser/0, parser/1]). -export([decoder/0, decoder/1]). -export([encoder/0]). -export([term_to_json/1, term_to_json/2]). -export([json_to_term/1, json_to_term/2]). -export([is_json/1, is_json/2]). -export([format/1, format/2]). -include("jsx_common.hrl"). -ifdef(TEST). -include_lib("eunit/include/eunit.hrl"). -endif. -spec parser() -> jsx_decoder(). parser() -> decoder([]). -spec parser(OptsList::jsx_opts()) -> jsx_decoder(). parser(OptsList) -> decoder(OptsList). -spec decoder() -> jsx_decoder(). decoder() -> decoder([]). -spec decoder(OptsList::jsx_opts()) -> jsx_decoder(). decoder(OptsList) -> case proplists:get_value(encoding, OptsList, auto) of utf8 -> jsx_utf8:decoder(OptsList) ; utf16 -> jsx_utf16:decoder(OptsList) ; utf32 -> jsx_utf32:decoder(OptsList) ; {utf16, little} -> jsx_utf16le:decoder(OptsList) ; {utf32, little} -> jsx_utf32le:decoder(OptsList) ; auto -> jsx_utils:detect_encoding(OptsList) end. -spec encoder() -> jsx_encoder(). encoder() -> encoder([]). -spec encoder(OptsList::jsx_opts()) -> jsx_encoder(). encoder(Opts) -> jsx_encoder:encoder(Opts). -spec json_to_term(JSON::binary()) -> eep0018(). json_to_term(JSON) -> try json_to_term(JSON, []) %% rethrow exception so internals aren't confusingly exposed to users catch error:badarg -> erlang:error(badarg, [JSON]) end. -spec json_to_term(JSON::binary(), Opts::decoder_opts()) -> eep0018(). json_to_term(JSON, Opts) -> jsx_eep0018:json_to_term(JSON, Opts). -spec term_to_json(JSON::eep0018()) -> binary(). term_to_json(JSON) -> try term_to_json(JSON, []) %% rethrow exception so internals aren't confusingly exposed to users catch error:badarg -> erlang:error(badarg, [JSON]) end. -spec term_to_json(JSON::eep0018(), Opts::encoder_opts()) -> binary(). term_to_json(JSON, Opts) -> try jsx_eep0018:term_to_json(JSON, Opts) %% rethrow exception so internals aren't confusingly exposed to users catch error:badarg -> erlang:error(badarg, [JSON, Opts]) end. -spec is_json(JSON::binary()) -> true | false ; (Terms::list(jsx_encodeable())) -> true | false. is_json(JSON) -> is_json(JSON, []). -spec is_json(JSON::binary(), Opts::verify_opts()) -> true | false ; (Terms::list(jsx_encodeable()), Opts::verify_opts()) -> true | false. is_json(JSON, Opts) -> jsx_verify:is_json(JSON, Opts). -spec format(JSON::binary()) -> binary() | iolist() ; (Terms::list(jsx_encodeable())) -> binary() | iolist(). format(JSON) -> format(JSON, []). -spec format(JSON::binary(), Opts::format_opts()) -> binary() | iolist() ; (Terms::list(jsx_encodeable()), Opts::format_opts()) -> binary() | iolist(). format(JSON, Opts) -> jsx_format:format(JSON, Opts). -ifdef(TEST). jsx_decoder_test_() -> jsx_decoder_gen(load_tests(?eunit_test_path)). jsx_decoder_gen([]) -> []; jsx_decoder_gen(Tests) -> jsx_decoder_gen(Tests, [utf8, utf16, {utf16, little}, utf32, {utf32, little} ]). jsx_decoder_gen([_Test|Rest], []) -> jsx_decoder_gen(Rest); jsx_decoder_gen([Test|_] = Tests, [Encoding|Encodings]) -> Name = lists:flatten(proplists:get_value(name, Test) ++ " :: " ++ io_lib:format("~p", [Encoding]) ), JSON = unicode:characters_to_binary(proplists:get_value(json, Test), unicode, Encoding ), JSX = proplists:get_value(jsx, Test), Flags = proplists:get_value(jsx_flags, Test, []), {generator, fun() -> [{Name, ?_assert(decode(JSON, Flags) =:= JSX)} | {generator, fun() -> [{Name ++ " incremental", ?_assert( incremental_decode(JSON, Flags) =:= JSX) } | jsx_decoder_gen(Tests, Encodings)] end } ] 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) -> %% should alert about badly formed tests eventually, but for now just skip %% over them case file:consult(Dir ++ "/" ++ Test) of {ok, TestSpec} -> try ParsedTest = parse_tests(TestSpec, Dir), load_tests(Rest, Dir, [ParsedTest] ++ Acc) catch _:_ -> load_tests(Rest, Dir, Acc) end ; {error, _Reason} -> load_tests(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) end; parse_tests([KV|Rest], Dir, Acc) -> parse_tests(Rest, Dir, [KV] ++ Acc); parse_tests([], _Dir, Acc) -> Acc. decode(JSON, Flags) -> P = jsx:decoder(Flags), decode_loop(P(JSON), []). decode_loop({event, end_json, _Next}, Acc) -> lists:reverse([end_json] ++ Acc); decode_loop({incomplete, More}, Acc) -> decode_loop(More(end_stream), Acc); decode_loop({event, E, Next}, Acc) -> decode_loop(Next(), [E] ++ Acc). incremental_decode(<>, Flags) -> P = jsx:decoder(Flags), incremental_decode_loop(P(C), Rest, []). incremental_decode_loop({incomplete, Next}, <<>>, Acc) -> incremental_decode_loop(Next(end_stream), <<>>, Acc); incremental_decode_loop({incomplete, Next}, <>, Acc) -> incremental_decode_loop(Next(C), Rest, Acc); incremental_decode_loop({event, end_json, _Next}, _Rest, Acc) -> lists:reverse([end_json] ++ Acc); incremental_decode_loop({event, Event, Next}, Rest, Acc) -> incremental_decode_loop(Next(), Rest, [Event] ++ Acc). multi_decode_test_() -> [ {"multiple values in a single stream", ?_assert( multi_decode(multi_json_body(), []) =:= multi_test_result() )} ]. multi_decode(JSON, Flags) -> P = jsx:decoder(Flags ++ [{multi_term, true}]), multi_decode_loop(P(JSON), [[]]). multi_decode_loop({incomplete, _Next}, [[]|Acc]) -> lists:reverse(Acc); multi_decode_loop({event, end_json, Next}, [S|Acc]) -> multi_decode_loop(Next(), [[]|[lists:reverse(S)] ++ Acc]); multi_decode_loop({event, E, Next}, [S|Acc]) -> multi_decode_loop(Next(), [[E] ++ S] ++ Acc). multi_json_body() -> <<"0 1 -1 1e1 0.7 0.7e-1 truefalsenull {} {\"key\": \"value\"}[] [1, 2, 3]\"hope this works\"">>. multi_test_result() -> [[{integer, 0}], [{integer, 1}], [{integer, -1}], [{float, 1.0e1}], [{float, 0.7}], [{float, 0.7e-1}], [{literal, true}], [{literal, false}], [{literal, null}], [start_object, end_object], [start_object, {key, "key"}, {string, "value"}, end_object], [start_array, end_array], [start_array, {integer, 1}, {integer, 2}, {integer, 3}, end_array], [{string, "hope this works"}] ]. -endif.