--- JSON-XS/XS.xs 2007/06/12 01:27:02 1.40 +++ JSON-XS/XS.xs 2007/07/26 11:33:35 1.56 @@ -2,31 +2,41 @@ #include "perl.h" #include "XSUB.h" -#include "assert.h" -#include "string.h" -#include "stdlib.h" -#include "stdio.h" +#include +#include +#include +#include +#include #if defined(__BORLANDC__) || defined(_MSC_VER) # define snprintf _snprintf // C compilers have this in stdio.h #endif -#define F_ASCII 0x00000001UL -#define F_LATIN1 0x00000002UL -#define F_UTF8 0x00000004UL -#define F_INDENT 0x00000008UL -#define F_CANONICAL 0x00000010UL -#define F_SPACE_BEFORE 0x00000020UL -#define F_SPACE_AFTER 0x00000040UL -#define F_ALLOW_NONREF 0x00000100UL -#define F_SHRINK 0x00000200UL -#define F_MAXDEPTH 0xf8000000UL -#define S_MAXDEPTH 27 +// some old perls do not have this, try to make it work, no +// guarentees, though. if it breaks, you get to keep the pieces. +#ifndef UTF8_MAXBYTES +# define UTF8_MAXBYTES 13 +#endif -#define DEC_DEPTH(flags) (1UL << ((flags & F_MAXDEPTH) >> S_MAXDEPTH)) +#define F_ASCII 0x00000001UL +#define F_LATIN1 0x00000002UL +#define F_UTF8 0x00000004UL +#define F_INDENT 0x00000008UL +#define F_CANONICAL 0x00000010UL +#define F_SPACE_BEFORE 0x00000020UL +#define F_SPACE_AFTER 0x00000040UL +#define F_ALLOW_NONREF 0x00000100UL +#define F_SHRINK 0x00000200UL +#define F_ALLOW_BLESSED 0x00000400UL +#define F_CONV_BLESSED 0x00000800UL +#define F_MAXDEPTH 0xf8000000UL +#define S_MAXDEPTH 27 +#define F_MAXSIZE 0x01f00000UL +#define S_MAXSIZE 20 +#define F_HOOK 0x00080000UL // some hooks exist, so slow-path processing -// F_SELFCONVERT? <=> to_json/toJson -// F_BLESSED? <=> { $__class__$ => } +#define DEC_DEPTH(flags) (1UL << ((flags & F_MAXDEPTH) >> S_MAXDEPTH)) +#define DEC_SIZE(flags) (1UL << ((flags & F_MAXSIZE ) >> S_MAXSIZE )) #define F_PRETTY F_INDENT | F_SPACE_BEFORE | F_SPACE_AFTER #define F_DEFAULT (9UL << S_MAXDEPTH) @@ -50,21 +60,19 @@ #define expect_false(expr) expect ((expr) != 0, 0) #define expect_true(expr) expect ((expr) != 0, 1) -static HV *json_stash; // JSON::XS:: +static HV *json_stash, *json_boolean_stash; // JSON::XS:: +static SV *json_true, *json_false; + +typedef struct { + U32 flags; + SV *cb_object; + HV *cb_sk_object; +} JSON; ///////////////////////////////////////////////////////////////////////////// // utility functions -static UV * -SvJSON (SV *sv) -{ - if (!(SvROK (sv) && SvOBJECT (SvRV (sv)) && SvSTASH (SvRV (sv)) == json_stash)) - croak ("object is not of type JSON::XS"); - - return &SvUVX (SvRV (sv)); -} - -static void +inline void shrink (SV *sv) { sv_utf8_downgrade (sv, 1); @@ -109,7 +117,7 @@ char *cur; // SvPVX (sv) + current output position char *end; // SvEND (sv) SV *sv; // result scalar - U32 flags; // F_* + JSON json; U32 indent; // indentation level U32 maxdepth; // max. indentation/recursion level } enc_t; @@ -193,7 +201,7 @@ if (uch > 0x10FFFFUL) croak ("out of range codepoint (0x%lx) encountered, unrepresentable in JSON", (unsigned long)uch); - if (uch < 0x80 || enc->flags & F_ASCII || (enc->flags & F_LATIN1 && uch > 0xFF)) + if (uch < 0x80 || enc->json.flags & F_ASCII || (enc->json.flags & F_LATIN1 && uch > 0xFF)) { if (uch > 0xFFFFUL) { @@ -217,7 +225,7 @@ str += clen; } - else if (enc->flags & F_LATIN1) + else if (enc->json.flags & F_LATIN1) { *enc->cur++ = uch; str += clen; @@ -248,7 +256,7 @@ inline void encode_indent (enc_t *enc) { - if (enc->flags & F_INDENT) + if (enc->json.flags & F_INDENT) { int spaces = enc->indent * INDENT_STEP; @@ -268,7 +276,7 @@ inline void encode_nl (enc_t *enc) { - if (enc->flags & F_INDENT) + if (enc->json.flags & F_INDENT) { need (enc, 1); encode_ch (enc, '\n'); @@ -280,9 +288,9 @@ { encode_ch (enc, ','); - if (enc->flags & F_INDENT) + if (enc->json.flags & F_INDENT) encode_nl (enc); - else if (enc->flags & F_SPACE_AFTER) + else if (enc->json.flags & F_SPACE_AFTER) encode_space (enc); } @@ -301,8 +309,14 @@ for (i = 0; i <= len; ++i) { + SV **svp = av_fetch (av, i, 0); + encode_indent (enc); - encode_sv (enc, *av_fetch (av, i, 0)); + + if (svp) + encode_sv (enc, *svp); + else + encode_str (enc, "null", 4, 0); if (i < len) encode_comma (enc); @@ -335,9 +349,9 @@ encode_ch (enc, '"'); - if (enc->flags & F_SPACE_BEFORE) encode_space (enc); + if (enc->json.flags & F_SPACE_BEFORE) encode_space (enc); encode_ch (enc, ':'); - if (enc->flags & F_SPACE_AFTER ) encode_space (enc); + if (enc->json.flags & F_SPACE_AFTER ) encode_space (enc); encode_sv (enc, HeVAL (he)); } @@ -382,7 +396,7 @@ // actually, this is mostly due to the stupid so-called // security workaround added somewhere in 5.8.x. // that randomises hash orderings - if (enc->flags & F_CANONICAL) + if (enc->json.flags & F_CANONICAL) { int fast = 1; HE *he; @@ -464,16 +478,78 @@ SvGETMAGIC (sv); svt = SvTYPE (sv); - if (svt == SVt_PVHV) + if (expect_false (SvOBJECT (sv))) + { + if (SvSTASH (sv) == json_boolean_stash) + { + if (SvIV (sv)) + encode_str (enc, "true", 4, 0); + else + encode_str (enc, "false", 5, 0); + } + else + { +#if 0 + if (0 && sv_derived_from (rv, "JSON::Literal")) + { + // not yet + } +#endif + if (enc->json.flags & F_CONV_BLESSED) + { + // we re-bless the reference to get overload and other niceties right + GV *to_json = gv_fetchmethod_autoload (SvSTASH (sv), "TO_JSON", 0); + + if (to_json) + { + int count; + dSP; + + ENTER; SAVETMPS; PUSHMARK (SP); + XPUSHs (sv_bless (sv_2mortal (newRV_inc (sv)), SvSTASH (sv))); + + // calling with G_SCALAR ensures that we always get a 1 return value + PUTBACK; + call_sv ((SV *)GvCV (to_json), G_SCALAR); + SPAGAIN; + + // catch this surprisingly common error + if (SvROK (TOPs) && SvRV (TOPs) == sv) + croak ("%s::TO_JSON method returned same object as was passed instead of a new one", HvNAME (SvSTASH (sv))); + + sv = POPs; + PUTBACK; + + encode_sv (enc, sv); + + FREETMPS; LEAVE; + } + else if (enc->json.flags & F_ALLOW_BLESSED) + encode_str (enc, "null", 4, 0); + else + croak ("encountered object '%s', but neither allow_blessed enabled nor TO_JSON method available on it", + SvPV_nolen (sv_2mortal (newRV_inc (sv)))); + } + else if (enc->json.flags & F_ALLOW_BLESSED) + encode_str (enc, "null", 4, 0); + else + croak ("encountered object '%s', but neither allow_blessed nor convert_blessed settings are enabled", + SvPV_nolen (sv_2mortal (newRV_inc (sv)))); + } + } + else if (svt == SVt_PVHV) encode_hv (enc, (HV *)sv); else if (svt == SVt_PVAV) encode_av (enc, (AV *)sv); else if (svt < SVt_PVAV) { - if (SvNIOK (sv) && SvIV (sv) == 0) - encode_str (enc, "false", 5, 0); - else if (SvNIOK (sv) && SvIV (sv) == 1) + STRLEN len = 0; + char *pv = svt ? SvPV (sv, len) : 0; + + if (len == 1 && *pv == '1') encode_str (enc, "true", 4, 0); + else if (len == 1 && *pv == '0') + encode_str (enc, "false", 5, 0); else croak ("cannot encode reference to scalar '%s' unless the scalar is 0 or 1", SvPV_nolen (sv_2mortal (newRV_inc (sv)))); @@ -553,19 +629,19 @@ } static SV * -encode_json (SV *scalar, U32 flags) +encode_json (SV *scalar, JSON *json) { enc_t enc; - if (!(flags & F_ALLOW_NONREF) && !SvROK (scalar)) + if (!(json->flags & F_ALLOW_NONREF) && !SvROK (scalar)) croak ("hash- or arrayref expected (not a simple scalar, use allow_nonref to allow this)"); - enc.flags = flags; + enc.json = *json; enc.sv = sv_2mortal (NEWSV (0, INIT_SIZE)); enc.cur = SvPVX (enc.sv); enc.end = SvEND (enc.sv); enc.indent = 0; - enc.maxdepth = DEC_DEPTH (flags); + enc.maxdepth = DEC_DEPTH (enc.json.flags); SvPOK_only (enc.sv); encode_sv (&enc, scalar); @@ -573,10 +649,10 @@ SvCUR_set (enc.sv, enc.cur - SvPVX (enc.sv)); *SvEND (enc.sv) = 0; // many xs functions expect a trailing 0 for text strings - if (!(flags & (F_ASCII | F_LATIN1 | F_UTF8))) + if (!(enc.json.flags & (F_ASCII | F_LATIN1 | F_UTF8))) SvUTF8_on (enc.sv); - if (enc.flags & F_SHRINK) + if (enc.json.flags & F_SHRINK) shrink (enc.sv); return enc.sv; @@ -591,7 +667,7 @@ char *cur; // current parser pointer char *end; // end of input string const char *err; // parse error, if != 0 - U32 flags; // F_* + JSON json; U32 depth; // recursion depth U32 maxdepth; // recursion depth limit } dec_t; @@ -864,9 +940,11 @@ if (!is_nv) { + int len = dec->cur - start; + // special case the rather common 1..4-digit-int case, assumes 32 bit ints or so if (*start == '-') - switch (dec->cur - start) + switch (len) { case 2: return newSViv (-( start [1] - '0' * 1)); case 3: return newSViv (-( start [1] * 10 + start [2] - '0' * 11)); @@ -874,7 +952,7 @@ case 5: return newSViv (-(start [1] * 1000 + start [2] * 100 + start [3] * 10 + start [4] - '0' * 1111)); } else - switch (dec->cur - start) + switch (len) { case 1: return newSViv ( start [0] - '0' * 1); case 2: return newSViv ( start [0] * 10 + start [1] - '0' * 11); @@ -884,7 +962,7 @@ { UV uv; - int numtype = grok_number (start, dec->cur - start, &uv); + int numtype = grok_number (start, len, &uv); if (numtype & IS_NUMBER_IN_UV) if (numtype & IS_NUMBER_NEG) { @@ -893,12 +971,24 @@ } else return newSVuv (uv); - - // here would likely be the place for bigint support } + + len -= *start == '-' ? 1 : 0; + + // does not fit into IV or UV, try NV + if ((sizeof (NV) == sizeof (double) && DBL_DIG >= len) + #if defined (LDBL_DIG) + || (sizeof (NV) == sizeof (long double) && LDBL_DIG >= len) + #endif + ) + // fits into NV without loss of precision + return newSVnv (Atof (start)); + + // everything else fails, convert it to a string + return newSVpvn (start, dec->cur - start); } - // if we ever support bigint or bigfloat, this is the place for bigfloat + // loss of precision here return newSVnv (Atof (start)); fail: @@ -952,6 +1042,7 @@ static SV * decode_hv (dec_t *dec) { + SV *sv; HV *hv = newHV (); DEC_INC_DEPTH; @@ -962,25 +1053,63 @@ else for (;;) { - SV *key, *value; - decode_ws (dec); EXPECT_CH ('"'); - key = decode_str (dec); - if (!key) - goto fail; + // heuristic: assume that + // a) decode_str + hv_store_ent are abysmally slow. + // b) most hash keys are short, simple ascii text. + // => try to "fast-match" such strings to avoid + // the overhead of decode_str + hv_store_ent. + { + SV *value; + char *p = dec->cur; + char *e = p + 24; // only try up to 24 bytes - decode_ws (dec); EXPECT_CH (':'); + for (;;) + { + // the >= 0x80 is true on most architectures + if (p == e || *p < 0x20 || *p >= 0x80 || *p == '\\') + { + // slow path, back up and use decode_str + SV *key = decode_str (dec); + if (!key) + goto fail; - value = decode_sv (dec); - if (!value) - { - SvREFCNT_dec (key); - goto fail; - } + decode_ws (dec); EXPECT_CH (':'); + + value = decode_sv (dec); + if (!value) + { + SvREFCNT_dec (key); + goto fail; + } + + hv_store_ent (hv, key, value, 0); + SvREFCNT_dec (key); + + break; + } + else if (*p == '"') + { + // fast path, got a simple key + char *key = dec->cur; + int len = p - key; + dec->cur = p + 1; - hv_store_ent (hv, key, value, 0); - SvREFCNT_dec (key); + decode_ws (dec); EXPECT_CH (':'); + + value = decode_sv (dec); + if (!value) + goto fail; + + hv_store (hv, key, len, value, 0); + + break; + } + + ++p; + } + } decode_ws (dec); @@ -997,7 +1126,67 @@ } DEC_DEC_DEPTH; - return newRV_noinc ((SV *)hv); + sv = newRV_noinc ((SV *)hv); + + // check filter callbacks + if (dec->json.flags & F_HOOK) + { + if (dec->json.cb_sk_object && HvKEYS (hv) == 1) + { + HE *cb, *he; + + hv_iterinit (hv); + he = hv_iternext (hv); + hv_iterinit (hv); + + // the next line creates a mortal sv each time its called. + // might want to optimise this for common cases. + cb = hv_fetch_ent (dec->json.cb_sk_object, hv_iterkeysv (he), 0, 0); + + if (cb) + { + dSP; + int count; + + ENTER; SAVETMPS; PUSHMARK (SP); + XPUSHs (HeVAL (he)); + + PUTBACK; count = call_sv (HeVAL (cb), G_ARRAY); SPAGAIN; + + if (count == 1) + { + sv = newSVsv (POPs); + FREETMPS; LEAVE; + return sv; + } + + FREETMPS; LEAVE; + } + } + + if (dec->json.cb_object) + { + dSP; + int count; + + ENTER; SAVETMPS; PUSHMARK (SP); + XPUSHs (sv_2mortal (sv)); + + PUTBACK; count = call_sv (dec->json.cb_object, G_ARRAY); SPAGAIN; + + if (count == 1) + { + sv = newSVsv (POPs); + FREETMPS; LEAVE; + return sv; + } + + SvREFCNT_inc (sv); + FREETMPS; LEAVE; + } + } + + return sv; fail: SvREFCNT_dec (hv); @@ -1027,7 +1216,7 @@ if (dec->end - dec->cur >= 4 && !memcmp (dec->cur, "true", 4)) { dec->cur += 4; - return newSViv (1); + return SvREFCNT_inc (json_true); } else ERR ("'true' expected"); @@ -1038,7 +1227,7 @@ if (dec->end - dec->cur >= 5 && !memcmp (dec->cur, "false", 5)) { dec->cur += 5; - return newSViv (0); + return SvREFCNT_inc (json_false); } else ERR ("'false' expected"); @@ -1066,7 +1255,7 @@ } static SV * -decode_json (SV *string, U32 flags, UV *offset_return) +decode_json (SV *string, JSON *json, UV *offset_return) { dec_t dec; UV offset; @@ -1075,19 +1264,26 @@ SvGETMAGIC (string); SvUPGRADE (string, SVt_PV); - if (flags & F_UTF8) + if (json->flags & F_MAXSIZE && SvCUR (string) > DEC_SIZE (json->flags)) + croak ("attempted decode of JSON text of %lu bytes size, but max_size is set to %lu", + (unsigned long)SvCUR (string), (unsigned long)DEC_SIZE (json->flags)); + + if (json->flags & F_UTF8) sv_utf8_downgrade (string, 0); else sv_utf8_upgrade (string); SvGROW (string, SvCUR (string) + 1); // should basically be a NOP - dec.flags = flags; + dec.json = *json; dec.cur = SvPVX (string); dec.end = SvEND (string); dec.err = 0; dec.depth = 0; - dec.maxdepth = DEC_DEPTH (dec.flags); + dec.maxdepth = DEC_DEPTH (dec.json.flags); + + if (dec.json.cb_object || dec.json.cb_sk_object) + dec.json.flags |= F_HOOK; *dec.end = 0; // this should basically be a nop, too, but make sure it's there sv = decode_sv (&dec); @@ -1107,7 +1303,7 @@ if (offset_return || !sv) { - offset = dec.flags & F_UTF8 + offset = dec.json.flags & F_UTF8 ? dec.cur - SvPVX (string) : utf8_distance (dec.cur, SvPVX (string)); @@ -1136,7 +1332,7 @@ sv = sv_2mortal (sv); - if (!(dec.flags & F_ALLOW_NONREF) && !SvROK (sv)) + if (!(dec.json.flags & F_ALLOW_NONREF) && !SvROK (sv)) croak ("JSON text must be an object or array (but found number, string, true, false or null, use allow_nonref to allow this)"); return sv; @@ -1158,46 +1354,52 @@ : i >= 'A' && i <= 'F' ? i - 'A' + 10 : -1; - json_stash = gv_stashpv ("JSON::XS", 1); + json_stash = gv_stashpv ("JSON::XS" , 1); + json_boolean_stash = gv_stashpv ("JSON::XS::Boolean", 1); + + json_true = get_sv ("JSON::XS::true" , 1); SvREADONLY_on (json_true ); + json_false = get_sv ("JSON::XS::false", 1); SvREADONLY_on (json_false); } PROTOTYPES: DISABLE -SV *new (char *dummy) - CODE: - RETVAL = sv_bless (newRV_noinc (newSVuv (F_DEFAULT)), json_stash); - OUTPUT: - RETVAL +void new (char *klass) + PPCODE: +{ + SV *pv = NEWSV (0, sizeof (JSON)); + SvPOK_only (pv); + Zero (SvPVX (pv), 1, JSON); + ((JSON *)SvPVX (pv))->flags = F_DEFAULT; + XPUSHs (sv_2mortal (sv_bless (newRV_noinc (pv), json_stash))); +} -SV *ascii (SV *self, int enable = 1) +void ascii (JSON *self, int enable = 1) ALIAS: - ascii = F_ASCII - latin1 = F_LATIN1 - utf8 = F_UTF8 - indent = F_INDENT - canonical = F_CANONICAL - space_before = F_SPACE_BEFORE - space_after = F_SPACE_AFTER - pretty = F_PRETTY - allow_nonref = F_ALLOW_NONREF - shrink = F_SHRINK - CODE: + ascii = F_ASCII + latin1 = F_LATIN1 + utf8 = F_UTF8 + indent = F_INDENT + canonical = F_CANONICAL + space_before = F_SPACE_BEFORE + space_after = F_SPACE_AFTER + pretty = F_PRETTY + allow_nonref = F_ALLOW_NONREF + shrink = F_SHRINK + allow_blessed = F_ALLOW_BLESSED + convert_blessed = F_CONV_BLESSED + PPCODE: { - UV *uv = SvJSON (self); if (enable) - *uv |= ix; + self->flags |= ix; else - *uv &= ~ix; + self->flags &= ~ix; - RETVAL = newSVsv (self); + XPUSHs (ST (0)); } - OUTPUT: - RETVAL -SV *max_depth (SV *self, UV max_depth = 0x80000000UL) - CODE: +void max_depth (JSON *self, UV max_depth = 0x80000000UL) + PPCODE: { - UV *uv = SvJSON (self); UV log2 = 0; if (max_depth > 0x80000000UL) max_depth = 0x80000000UL; @@ -1205,41 +1407,93 @@ while ((1UL << log2) < max_depth) ++log2; - *uv = *uv & ~F_MAXDEPTH | (log2 << S_MAXDEPTH); + self->flags = self->flags & ~F_MAXDEPTH | (log2 << S_MAXDEPTH); - RETVAL = newSVsv (self); + XPUSHs (ST (0)); } - OUTPUT: - RETVAL -void encode (SV *self, SV *scalar) +void max_size (JSON *self, UV max_size = 0) PPCODE: - XPUSHs (encode_json (scalar, *SvJSON (self))); +{ + UV log2 = 0; + + if (max_size > 0x80000000UL) max_size = 0x80000000UL; + if (max_size == 1) max_size = 2; + + while ((1UL << log2) < max_size) + ++log2; + + self->flags = self->flags & ~F_MAXSIZE | (log2 << S_MAXSIZE); + + XPUSHs (ST (0)); +} -void decode (SV *self, SV *jsonstr) +void filter_json_object (JSON *self, SV *cb = &PL_sv_undef) PPCODE: - XPUSHs (decode_json (jsonstr, *SvJSON (self), 0)); +{ + SvREFCNT_dec (self->cb_object); + self->cb_object = SvOK (cb) ? newSVsv (cb) : 0; -void decode_prefix (SV *self, SV *jsonstr) + XPUSHs (ST (0)); +} + +void filter_json_single_key_object (JSON *self, SV *key, SV *cb = &PL_sv_undef) + PPCODE: +{ + if (!self->cb_sk_object) + self->cb_sk_object = newHV (); + + if (SvOK (cb)) + hv_store_ent (self->cb_sk_object, key, newSVsv (cb), 0); + else + { + hv_delete_ent (self->cb_sk_object, key, G_DISCARD, 0); + + if (!HvKEYS (self->cb_sk_object)) + { + SvREFCNT_dec (self->cb_sk_object); + self->cb_sk_object = 0; + } + } + + XPUSHs (ST (0)); +} + +void encode (JSON *self, SV *scalar) + PPCODE: + XPUSHs (encode_json (scalar, self)); + +void decode (JSON *self, SV *jsonstr) + PPCODE: + XPUSHs (decode_json (jsonstr, self, 0)); + +void decode_prefix (JSON *self, SV *jsonstr) PPCODE: { UV offset; EXTEND (SP, 2); - PUSHs (decode_json (jsonstr, *SvJSON (self), &offset)); + PUSHs (decode_json (jsonstr, self, &offset)); PUSHs (sv_2mortal (newSVuv (offset))); } +void DESTROY (JSON *self) + CODE: + SvREFCNT_dec (self->cb_sk_object); + SvREFCNT_dec (self->cb_object); + PROTOTYPES: ENABLE void to_json (SV *scalar) - ALIAS: - objToJson = 0 PPCODE: - XPUSHs (encode_json (scalar, F_DEFAULT | F_UTF8)); +{ + JSON json = { F_DEFAULT | F_UTF8 }; + XPUSHs (encode_json (scalar, &json)); +} void from_json (SV *jsonstr) - ALIAS: - jsonToObj = 0 PPCODE: - XPUSHs (decode_json (jsonstr, F_DEFAULT | F_UTF8, 0)); +{ + JSON json = { F_DEFAULT | F_UTF8 }; + XPUSHs (decode_json (jsonstr, &json, 0)); +}