JSON Serializer - 2022/09/07 - beta.8

[TheArkive]

I found this script on GitHub thanks to user @Coco (if I'm not mistaken).

For AHK v2:

• all quoted strings are properly detected regardless of contents (like numbers)
• all linear arrays and maps are properly detected even when empty
• unquoted numbers are output as unquoted on dump, and are properly read on load

This isn't as fancy as @HotKeyIt's Yaml and Json parser but it gets the job done.

===================================================================

Updates

2021/11/05

• Changed some "strings" to 'strings' so a separate var for Chr(34) (") is unnecessary.
• Fixed an issue where "\" in an item name was not properly processed on dump causing an error on load.

2021/06/21

• tested and working on a137

2021/05/29

• Added more detailed error msg when "invalid obj" is passed. Now Type(…) is used to indicate the invalid obj type.

2021/05/08

• tested and working in a134

2021/05/03

• fixed incorrect additional escaping (ie. \n to \\n)
  thanks to @dd900 for reporting this

2021/04/19

• minor changes to example
• tested and working with a131
• jxon_load(&obj) now requires a &VarRef
• moved to github

2021/03/08

• Changed ByRef src to just src for Jxon_load()
  Given the new VarRef, and how it is handled, it throws an error unless you explicitly pass a &VarRef. I didn't really see how passing a VarRef in this case would be beneficial so for now it is removed.
• Removed some "code noise" that were remnants from the old code that no longer made sense or did anything, mostly commented stuff

2020/12/01

• Thanks to @bmcclure for pointing out the failed handling of strings "true" and "false". This is now fixed.
• Thanks to @bmcclure again for pointing out the Jxon_load() didn't properly check for null, true, false.

2020/07/19

• Tested on a119 - working

2020/07/17

• Tested on AHK v2-a116, verified working
• Added examples for easy testing

2020/07/09

• User @Tigerlily caught a bug, escaped / wasn't being read properly. This is now fixed.
• Verified working in a115

2020/07/01

• Test with v2-a113, no issues yet

2020/06/20

• Updated for AHK v2-a112

2020/04/19

• Forgot to retain translation of special characters \r, \n, \t, \f, \b, \\, \", put those back in

===================================================================

Download on Github

[TheArkive]

=========================================================================================
AHK v1 JSON Serializer moved to this thread.
=========================================================================================

[TheArkive]

Latest Update: 2020/07/09

Updated AHK v1 / v2 JXON for escaped /. It was commented out (can't remember why). User @Tigerlily caught this and reported it.

[Tigerlily]

@TheArkive
Thank you for posting this. I'm running into an issue with the first string i tried to parse, can you let me know what I'm doing wrong?

code:

Code: Select all

word := "wonderful"

/*
{
    "glossary": {
        "title": "example glossary",
		"GlossDiv": {
            "title": "S",
			"GlossList": {
                "GlossEntry": {
                    "ID": "SGML",
					"SortAs": "SGML",
					"GlossTerm": "Standard Generalized Markup Language",
					"Acronym": "SGML",
					"Abbrev": "ISO 8879:1986",
					"GlossDef": {
                        "para": "A meta-markup language, used to create markup languages such as DocBook.",
						"GlossSeeAlso": ["GML", "XML"]
                    },
					"GlossSee": "markup"
                }
            }
        }
    }
}
*/

json := FileRead( A_ScriptDir "\dictionary_" word ".txt" )

wordInfo := Jxon_Load( json )

MsgBox wordInfo["glossary", "title"]

error:

[kczx3]

Separate out your keys to both be in brackets. Or just use dot notation.

[Tigerlily]

Separate out your keys to both be in brackets. Or just use dot notation.

I tried dot notation and receive this error:



However, for some reason bracket notation worked fine so I'll stick with that for now.. although dot notation would be a little less typing

[TheArkive]

In AHK v1, keys vs dot notation is interchangable. In AHK v2 it isn't. So if you are working with a map you need obj["key"] notation.

Did ya get it working ok?

[Tigerlily]

I'm receiving this string from the Merriam Webster dictionary:

Code: Select all

{"meta":{"id":"wonderful","uuid":"70456b1b-72ae-43ed-85cd-3e19ccf4b864","sort":"230207100","src":"collegiate","section":"alpha","stems":["wonderful","wonderfuller","wonderfullest","wonderfully","wonderfulness","wonderfulnesses"],"offensive":false},"hwi":{"hw":"won*der*ful","prs":[{"mw":"\u02c8w\u0259n-d\u0259r-f\u0259l","sound":{"audio":"wonder03","ref":"c","stat":"1"}}]},"fl":"adjective","def":[{"sseq":[[["sense",{"sn":"1","dt":[["text","{bc}exciting {a_link|wonder} {bc}{sx|marvelous||}, {sx|astonishing||} "],["vis",[{"t":"a sight {wi}wonderful{\/wi} to behold"}]]]}]],[["sense",{"sn":"2","dt":[["text","{bc}unusually good {bc}{sx|admirable||} "],["vis",[{"t":"did a {wi}wonderful{\/wi} job"}]]]}]]]}],"uros":[{"ure":"won*der*ful*ly","prs":[{"mw":"\u02c8w\u0259n-d\u0259r-f(\u0259-)l\u0113","sound":{"audio":"wonder04","ref":"c","stat":"1"}}],"fl":"adverb"},{"ure":"won*der*ful*ness","prs":[{"mw":"\u02c8w\u0259n-d\u0259r-f\u0259l-n\u0259s","sound":{"audio":"wonder05","ref":"c","stat":"1"}}],"fl":"noun"}],"date":"before 12th century{ds||1||}","shortdef":["exciting wonder : marvelous, astonishing","unusually good : admirable"]}

beautified:

Code: Select all

{
	"meta": {
		"id": "wonderful",
		"uuid": "70456b1b-72ae-43ed-85cd-3e19ccf4b864",
		"sort": "230207100",
		"src": "collegiate",
		"section": "alpha",
		"stems": ["wonderful", "wonderfuller", "wonderfullest", "wonderfully", "wonderfulness", "wonderfulnesses"],
		"offensive": false
	},
	"hwi": {
		"hw": "won*der*ful",
		"prs": [{
			"mw": "\u02c8w\u0259n-d\u0259r-f\u0259l",
			"sound": {
				"audio": "wonder03",
				"ref": "c",
				"stat": "1"
			}
		}]
	},
	"fl": "adjective",
	"def": [{
		"sseq": [
			[
				["sense", {
					"sn": "1",
					"dt": [
						["text", "{bc}exciting {a_link|wonder} {bc}{sx|marvelous||}, {sx|astonishing||} "],
						["vis", [{
							"t": "a sight {wi}wonderful{\/wi} to behold"
						}]]
					]
				}]
			],
			[
				["sense", {
					"sn": "2",
					"dt": [
						["text", "{bc}unusually good {bc}{sx|admirable||} "],
						["vis", [{
							"t": "did a {wi}wonderful{\/wi} job"
						}]]
					]
				}]
			]
		]
	}],
	"uros": [{
		"ure": "won*der*ful*ly",
		"prs": [{
			"mw": "\u02c8w\u0259n-d\u0259r-f(\u0259-)l\u0113",
			"sound": {
				"audio": "wonder04",
				"ref": "c",
				"stat": "1"
			}
		}],
		"fl": "adverb"
	}, {
		"ure": "won*der*ful*ness",
		"prs": [{
			"mw": "\u02c8w\u0259n-d\u0259r-f\u0259l-n\u0259s",
			"sound": {
				"audio": "wonder05",
				"ref": "c",
				"stat": "1"
			}
		}],
		"fl": "noun"
	}],
	"date": "before 12th century{ds||1||}",
	"shortdef": ["exciting wonder : marvelous, astonishing", "unusually good : admirable"]
}

I am receiving an error using this code:

Code: Select all

word := "wonderful"
Download( "https://www.dictionaryapi.com/api/v3/references/collegiate/json/" word "?key=YOUR-API-KEY", A_ScriptDir "\dictionary_" word ".txt" )
json := FileRead( A_ScriptDir "\dictionary_" word ".txt" )
json := Trim( json, "[]" ) ; for some reason the returned string comes with a set of square brackets encasing the JSON object
wordInfo := Jxon_Load( json )
MsgBox wordInfo["meta"]["id"]

error:


the culprit:

Code: Select all

							"t": "a sight {wi}wonderful{\/wi} to behold"
						}]]
					]
				}]
			],
			[
				["sense", {
					"sn": "2",
					"dt": [
						["text", "{bc}unusually good {bc}{sx|admirable||} "],
						["vis", [{
							"t": "did a {wi}wonderful{\/wi} job"

when I remove the two \/ everything seems to work fine. I checked and the string is valid JSON, is this the APIs string causing this issue?

[Tigerlily]

@TheArkive
thanks for the heads up, that makes sense why the dot notation isn't working.

i got it working with a very simple json example string, however, now after trying to pull string from an API, getting the above issue.

[TheArkive]

Try NOT trimming the brackets.

the Brackets represent a linear array []. Curly braces {} represent a map (or associative array). The top level of the json element will have one of these always. That's how objects are saved / layered. By removing this, you are actually breaking it.

Let me know what happens when you don't trim the braces.

[TheArkive]

Oh i see ... top level is [] ... and it still has {} as the next level down? that's a little excessive ;P ... ok i'm trying to load this up and see what i see

EDIT: i got it to load. Gotta re-add the escape for /. Should be around line 71 ish:

val := StrReplace(val, "\/", "/")

uncomment this line and try again.

EDIT: It's working... return value was "wonderful" as expected.

EDIT: Just to be extra sure more errors wouldn't pop up, it's double confirmed it was the escape for / ... so where you see \/ was causing it. I had that line that did that replacement commented out, not sure why. But thanks for reporting! I'll fix this in the OP.

[Tigerlily]

@TheArkive
Thanks, you rock!

Really appreciate you updating this lib for a115!!!!!

[TheArkive]

Update 2020/10/10 - for AHK v1 version (post #2)

• Fixed an error when trying to load arrays. Updated Jxon_dump(), now it properly quotes keys that are numerical values in Object() arrays. Unquoted keys were the cause of the error.

[JoeSchmoe]

Hey, man, I just wanted to thank you for updating this. Good stuff, and much needed.

[TheArkive]

@JoeSchmoe
Glad you are able to make use of this

[Curdflappers]

@TheArkive Thanks so much! I've been working on converting this for a few days, but I'm very new to AHK syntax. I'm working on this script on GitHub, do you mind if I incorporate your changes to my repo, crediting you, of course?

[TheArkive]

@Curdflappers
Sure man, no problem. What exactly are you trying to convert? I have both AHK v1 and v2 scripts posted in this thread. AHK v1 version is in post #2.

[Curdflappers]

@TheArkive: I'm working on updating Chrome.ahk by G33kDude, which allows AHK scripts to navigate Chromium browsers like Google Chrome and Microsoft Edge. It logs through an old JSON-parsing library originally written by cocobelgica. In order to update Chrome.ahk, I need to update the JSON-parsing library.

[TheArkive]

@Curdflappers
Look at the 2nd post in this thread. My library is actually already converted from cocobelgica (see 1st post, 1st link). Just don't want you to spend unnecessary time if ya don't have to.

Post #1 is for AHK v2
Post #2 is for AHK v1

Hopefully you can just copy-paste for whatever version of AHK you are writing / converting Chrome.ahk for.

[Curdflappers]

Yeah, you're right, I didn't think my response through. I'm working on updating a fork of Coco (and G33kDude)'s repository, so I wanted to verify that this was OK to publish on my account. I'll give you credit in the script, of course!