-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjson-doc.html
executable file
·376 lines (340 loc) · 14.9 KB
/
json-doc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
<!DOCTYPE html>
<html lang="en">
<head>
<!--__GOLF_REDIRECT__-->
<title>Json doc</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="HandheldFriendly" content="True"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="canonical" href="https://golf-lang.com/json-doc.html" />
<style>
body, html {
color:black;
text-rendering: optimizelegibility;
background-color: white;
min-height: 150%;
font-family: "Times New Roman";
font-weight:400;
font-size:18px;
line-height:27px;
letter-spacing: 2px;
z-index: 1;
height: 100%;
text-align:left;
width:80%;
margin-left:auto;
margin-right:auto;
padding:0;
/*font-family: Helvetica, Arial, sans-serif;*/
}
body {
padding-left:1vw;
padding-right:1vw;
}
.ncode {
line-height:20px;
letter-spacing: 0px;
font-size:14px;
font-family: monospace;
display:inline-block;
max-width:100%;
min-width:90%;
margin:0;
padding:0;
padding-left:5px;
padding-top:3px;
padding-bottom:3px;
margin-bottom:15px;
border: 2px solid #d6d6d6;
background-color:#f5f7f4;
white-space:nowrap;
}
.shcode {
line-height:23px;
letter-spacing: 0px;
font-size:14px;
font-family: monospace;
display:inline-block;
max-width:100%;
min-width:90%;
margin:0;
padding:0;
padding-left:5px;
padding-top:3px;
padding-bottom:3px;
margin-bottom:15px;
border: 2px solid #d6d6d6;
background-color:#f5f7f4;
white-space:nowrap;
}
.sqlcode {
line-height:23px;
letter-spacing: 0px;
font-size:14px;
font-family: monospace;
display:inline-block;
max-width:100%;
min-width:90%;
margin:0;
padding:0;
padding-left:5px;
padding-top:3px;
padding-bottom:3px;
margin-bottom:15px;
border: 2px solid #d6d6d6;
background-color:#f5f7f4;
white-space:nowrap;
}
.htmlcode {
line-height:23px;
letter-spacing: 0px;
font-size:14px;
font-family: monospace;
display:inline-block;
max-width:100%;
min-width:90%;
margin:0;
padding:0;
padding-left:5px;
padding-top:3px;
padding-bottom:3px;
margin-bottom:15px;
border: 2px solid #d6d6d6;
background-color:#f5f7f4;
white-space:nowrap;
}
.code {
line-height:23px;
letter-spacing: 0px;
font-size:14px;
font-family: monospace;
display:inline-block;
max-width:100%;
min-width:90%;
margin:0;
padding:0;
padding-left:5px;
padding-top:3px;
padding-bottom:3px;
margin-bottom:15px;
border: 2px solid #d6d6d6;
background-color:#f5f7f4;
white-space:nowrap;
}
/*Just like h1 but for pdf conversion it would be indented this way it's not*/
.vhub {
display: block;
font-size: 1.6em;
margin-top: 0.63em;
margin-bottom: 0.63em;
margin-left: 0;
margin-right: 0;
font-weight: bold;
}
/*Just like h2 but for pdf conversion it would be indented this way it's not*/
.vsub {
display: block;
font-size: 1.25em;
margin-top: 0.53em;
margin-bottom: 0.53em;
margin-left: 0;
margin-right: 0;
font-weight: bold;
}
ul {
margin-left: 0.75vw;
padding-left: 0;
}
li {
margin-left: 0.75vw;
padding-left: 0;
}
/* this must be last, as it overrides previous settings, for mobile */
@media (hover: none) {
a {
display: inline-block;
padding-top: 3px;
padding-bottom: 2px;
}
body {
padding-left:2vw;
padding-right:2vw;
font-size:14px;
line-height:22px;
letter-spacing: 1px;
}
}
/*The following is for code snippets that are highlighted by 2html vim*/
pre { overflow-x: scroll; margin:0; padding:0; font-family:monospace; }
.Identifier { color: #008b8b; }
.Statement { color: #af5f00; }
.PreProc { color: #5fd7ff; }
.Type { color: #005f00; }
.Comment { color: blue ; }
.Constant { color: #ff00ff; }
/*end of highlighted snippets*/
a {
text-decoration:none;
padding-bottom: 0px;
color:inherit;
border-bottom: 2px solid #6cb8f0;
}
a:hover {
text-decoration: none;
color:black;
border-bottom: 1px solid red;
}
/*do not underline links nor should they be active*/
pre a {
text-decoration:none;
color:black;
border-bottom: none;
pointer-events: none;
cursor: default;
}
.golfSnippet {display:none;}
ul {
list-style-type:square;
list-style-position: outside;
}
</style>
</head>
<body>
<script>
function gg_copy(gt, eid, gc) {
gt.textContent = eid.textContent;
gt.select();
document.execCommand("copy");
gc.style.visibility="visible"
setTimeout(()=>{ gc.style.visibility="hidden"; }, 1000);
}
</script>
<!--GOLFMENU13-->
<!--GOLFENDMENU13-->
<!--BEGVDOC90-->
<div class='vhub' style='margin-top:10px;margin-right:20px;text-align:right;background-color:white;'><a href='https://golf-lang.com' style='border-bottom:0px'><img src='https://golf-lang.com/golf.png'/></a></div><div class='vhub' style='margin-top:10px;'> Json doc</div><hr/><span style="font-weight:bold;">Purpose</span>: Parse JSON text.<br/>
<br/>
<div class='code' style='position:relative;padding-right:16px;'>
<pre id='code_559'>
<span class="Statement"> json-doc</span> <text><span class="Type"> to</span> <json> \
[<span class="Type"> status</span> <status> ] [<span class="Identifier"> length</span> <length> ] [<span class="Identifier"> noencode</span> ] [<span class="Identifier"> no-enum</span> ] \
[<span class="Type"> error-text</span> <error text> ] \
[<span class="Type"> error-position</span> <error position> ] \
[<span class="Type"> error-line</span> <line> ] \
[<span class="Type"> error-char</span> <<span class="Type">char</span>> ]
<span class="Statement"> json-doc</span> <span class="Identifier"> delete</span> <json></pre>
<span id=golf_copied_559 style='position:absolute;right:-14px;top:-30px; cursor: pointer;visibility:hidden;background:white;'>Copied!</span>
<textarea id='golft_559' style='position: absolute;left: -500%;'></textarea>
<img src='https://golf-lang.com/golf-copy-small-1.png' id='golfb' onclick='gg_copy(golft_559, code_559, golf_copied_559)' style='position:absolute;right:0;top:0; cursor: pointer;opacity:0.5;'/>
</div><br/>
json-doc will parse JSON <text> into <json> variable, which can be used with <a href='https://golf-lang.com/read-json.html'>read-json</a> to get the data.<br/>
<br/>
The length of <text> may be specified with "length" clause in <length> variable, or if not, it will be the string length of <text>.<br/>
<br/>
The "status" clause specifies the return <status> number, which is GG_OKAY if successful or GG_ERR_JSON if there is an error. The number <error position> in "error-position" clause is the byte position in <text> where error was found (starting with "0"), in which case <error text> in "error-text" clause is the error message. You can also obtain the error's line number (with number <line> in clause "error-line") and the character position within that line (with number <char> in clause "error-char").<br/>
<br/>
"noencode" clause will not encode strings, i.e. convert from JSON Unicode strings to UTF, nor will it perform any validity checks on strings. This may be useful as a performance boost or to pass along strings unencoded, however in most cases it is not needed.<br/>
<br/>
"no-enum" clause will not include indexing of arrays in normalized names (with "[..]"), see <a href='https://golf-lang.com/read-json.html'>read-json</a>. This is useful if you want to check the path of each data element, and not worry about counting them; this happens often when using JSON in a structured way to transfer arrays when data elements repeat in a predictable fashion. Parsing of JSON is also faster with "no-enum".<br/>
<br/>
The maximum depth of nested structures in JSON document (i.e. objects and arrays) is 32, and the maximum length of normalized leaf node name is 1024 (see <a href='https://golf-lang.com/read-json.html'>read-json</a> for more on normalized names). There is no limit on document size.<br/>
<div class="vsub"><a id="Deleting"></a>Deleting</div>
To delete a JSON variable, use "delete" clause with the <json>. This will delete all memory associated with it, and the variable <json> itself.<br/>
<div class="vsub"><a id="Examples"></a>Examples</div>
Parse the following JSON document and display all keys and values from it. You can use them as they come along, or store them into <a href='https://golf-lang.com/new-hash.html'>new-hash</a> or <a href='https://golf-lang.com/new-tree.html'>new-tree</a> for instance for searching of large documents. This also demonstrates usage of UTF8 characters:<br/>
<div class='code' style='position:relative;padding-right:16px;'>
<pre id='code_561'>
<span class="Comment">// JSON to parse</span>
<span class="Statement"> set-string</span> jd<span class="Identifier"> unquoted</span> = {<span class="Constant">"menu"</span>:\
{<span class="Constant">"id"</span>: <span class="Constant">"file"</span>,\
<span class="Constant">"value"</span>: <span class="Constant">23091</span>,\
<span class="Constant">"active"</span>: <span class="Constant">false</span>,\
<span class="Constant">"popup"</span>:\
{<span class="Constant">"menuitem"</span>:\
[{<span class="Constant">"value"</span>: <span class="Constant">"New"</span>, <span class="Constant">"onclick"</span>: <span class="Constant">"CreateNewDoc with</span><span class="Special">\uD834\uDD1E</span><span class="Constant">music"</span>},\
{<span class="Constant">"value"</span>: <span class="Constant">"Open"</span>, <span class="Constant">"onclick"</span>: <span class="Constant">"OpenDoc() with </span><span class="Special">\uD834\uDD1E\uD834\uDD1E</span><span class="Constant">"</span>},\
{<span class="Constant">"value"</span>: <span class="Constant">"Close"</span>, <span class="Constant">"onclick"</span>: <span class="Constant">"</span><span class="Special">\uD834\uDD1E</span><span class="Constant">CloseDoc()"</span>}\
]\
}\
}\
}
<span class="Comment">// Parse JSON</span>
<span class="Statement"> json-doc</span> jd<span class="Type"> status</span> st<span class="Type"> error-text</span> et<span class="Type"> error-position</span> ep<span class="Type"> to</span> nj
<span class="Comment">// Check parsing okay, if not display error details</span>
<span class="Statement"> if-true</span> st<span class="Identifier"> not-equal</span> GG_OKAY
<span class="Statement"> @</span>Error [<span class="Statement"><<p-out</span> et<span class="Statement">>></span>] at [<span class="Statement"><<p-num</span> ep<span class="Statement">>></span>]
<span class="Statement"> exit-handler</span> -<span class="Constant">1</span>
<span class="Statement"> end-if</span>
<span class="Comment">// Display all data elements in order from top to bottom</span>
<span class="Statement"> start-loop</span>
<span class="Statement"> read-json</span> nj<span class="Type"> key</span> k<span class="Type"> value</span> v<span class="Type"> type</span> t<span class="Identifier"> next</span>
<span class="Statement"> if-true</span> t<span class="Identifier"> equal</span> GG_JSON_TYPE_NONE
<span class="Statement"> break-loop</span>
<span class="Statement"> end-if</span>
<span class="Statement"> @</span>Key [<span class="Statement"><<p-out</span> k<span class="Statement">>></span>]
<span class="Statement"> @</span>Value [<span class="Statement"><<p-out</span> v<span class="Statement">>></span>]
<span class="Statement"> @</span>Type [<span class="Statement"><<p-num</span> t<span class="Statement">>></span>]
<span class="Statement"> @</span>--------
<span class="Statement"> end-loop</span>
<span class="Statement"> @</span>
<span class="Comment">// Delete JSON document</span>
<span class="Statement"> json-doc</span><span class="Identifier"> delete</span> nj</pre>
<span id=golf_copied_561 style='position:absolute;right:-14px;top:-30px; cursor: pointer;visibility:hidden;background:white;'>Copied!</span>
<textarea id='golft_561' style='position: absolute;left: -500%;'></textarea>
<img src='https://golf-lang.com/golf-copy-small-1.png' id='golfb' onclick='gg_copy(golft_561, code_561, golf_copied_561)' style='position:absolute;right:0;top:0; cursor: pointer;opacity:0.5;'/>
</div><br/>
The output would be:<br/>
<div class='ncode' style='position:relative;padding-right:16px;'>
<pre id='code_560'>
Key ["menu"."id"]
Value [file]
Type [0]
--------
Key ["menu"."value"]
Value [23091]
Type [1]
--------
Key ["menu"."active"]
Value [false]
Type [3]
--------
Key ["menu"."popup"."menuitem"[0]."value"]
Value [New]
Type [0]
--------
Key ["menu"."popup"."menuitem"[0]."onclick"]
Value [CreateNewDoc with𝄞music]
Type [0]
--------
Key ["menu"."popup"."menuitem"[1]."value"]
Value [Open]
Type [0]
--------
Key ["menu"."popup"."menuitem"[1]."onclick"]
Value [OpenDoc() with 𝄞𝄞]
Type [0]
--------
Key ["menu"."popup"."menuitem"[2]."value"]
Value [Close]
Type [0]
--------
Key ["menu"."popup"."menuitem"[2]."onclick"]
Value [𝄞CloseDoc()]
Type [0]
--------</pre>
<span id=golf_copied_560 style='position:absolute;right:-14px;top:-30px; cursor: pointer;visibility:hidden;background:white;'>Copied!</span>
<textarea id='golft_560' style='position: absolute;left: -500%;'></textarea>
<img src='https://golf-lang.com/golf-copy-small-1.png' id='golfb' onclick='gg_copy(golft_560, code_560, golf_copied_560)' style='position:absolute;right:0;top:0; cursor: pointer;opacity:0.5;'/>
</div><br/>
Note that if "no-enum" were used in json-doc, then all keys with arrays would not have "[..]", for instance the very last key above would be "menu"."popup"."menuitem"."onclick", i.e. there would be no indexing of arrays.<br/>
<div class="vsub"><a id="See also"></a>See also</div>
<a name='JSON parsing'></a><span style="font-weight:bold;">JSON parsing</span><br/>
<a href='https://golf-lang.com/json-doc.html'>json-doc</a> <br/>
<a href='https://golf-lang.com/read-json.html'>read-json</a> <br/>
<span style="font-weight:bold;">See all</span> <br/>
<a href='https://golf-lang.com/documentation.html'>documentation</a><br/>
<!--ENDVDOC90-->
<br/><div style='width:100%;clear:both;'>
<hr/>
<!--GOLFFOOT77--><span style='font-size:80%'><a href="https://golf-lang.com/copyright.html">Copyright</a> (c) 2019-2025 Gliim LLC. All contents on this web site is "AS IS" without warranties or guarantees of any kind.</span>
</div><br/></body></html>