zuzu-rust 0.5.0

Rust implementation of ZuzuScript
Documentation
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
=encoding utf8

=head1 NAME

std/path/z/node - Node wrapper used by std/path/z.

=head1 IMPLEMENTATION SUPPORT

This module is supported by all implementations of ZuzuScript.

=head1 DESCRIPTION

Objects of this class wrap underlying values and provide traversal and
coercion helpers used while evaluating ZPath expressions.

=head1 EXPORTS

=head2 Classes

=over

=item C<Node>

Base wrapper for values traversed by ZPath.

=over

=item C<< Node.from_root(obj) >>

Parameters: C<obj> is any query root. Returns: C<Node>. Wraps a root
value for traversal.

=item C<< Node.wrap(obj, parent?, key?, ix?) >>

Parameters: C<obj> is any value, with optional parent, key, and index
metadata. Returns: C<Node>. Wraps a value in the appropriate node
subclass.

=item C<< node.hold_parent(owner) >>

Parameters: C<owner> is a parent node. Returns: C<Node>. Retains parent
metadata on the node.

=item C<< node.raw() >>, C<< node.value() >>, C<< node.primitive_value() >>

Parameters: none. Returns: value. Returns the wrapped raw, node, or
primitive value.

=item C<< node.parent() >>

Parameters: none. Returns: C<Node> or C<null>. Returns the parent node.

=item C<< node.key() >>, C<< node.ix() >>, C<< node.index() >>, C<< node.id() >>

Parameters: none. Returns: value. Returns traversal key, index, or
stable node id metadata.

=item C<< node.type() >>, C<< node.name() >>

Parameters: none. Returns: C<String> or C<null>. Returns the node type
or name.

=item C<< node.tagged() >>

Parameters: none. Returns: C<String> or C<null>. Returns a KDL value
tag when present.

=item C<< node.has_tagged() >>

Parameters: none. Returns: C<Boolean>. Returns true when tag metadata is
available.

=item C<< node.string_value() >>, C<< node.number_value() >>

Parameters: none. Returns: C<String>, C<Number>, or C<null>. Coerces the
node for string or numeric ZPath operations.

=item C<< node.can_have_named_children() >>, C<< node.can_have_indexed_children() >>, C<< node.can_have_named_indexed_children() >>

Parameters: none. Returns: C<Boolean>. Reports supported child lookup
modes.

=item C<< node.named_child(name) >>, C<< node.indexed_child(i) >>, C<< node.named_indexed_child(name, i) >>

Parameters: C<name> is a child name and C<i> is an index. Returns:
C<Node> or C<null>. Looks up child nodes.

=item C<< node.next_child(child) >>, C<< node.prev_child(child) >>, C<< node.next_sibling() >>, C<< node.prev_sibling() >>

Parameters: C<child> is a child node where required. Returns: C<Node> or
C<null>. Traverses adjacent nodes.

=item C<< node.named_attribute(name) >>

Parameters: C<name> is an attribute name. Returns: C<Node> or C<null>.
Looks up one attribute node.

=item C<< node.children() >>, C<< node.attributes() >>

Parameters: none. Returns: C<Array>. Returns child or attribute nodes.

=item C<< node.dump() >>

Parameters: none. Returns: C<String>. Returns a diagnostic rendering of
the node.

=item C<< node.find(zpath) >>

Parameters: C<zpath> is a C<ZPath> object or subclass, such as C<ZZPath>.
Returns: C<Array>. Evaluates a nested path from this node and returns
selected node objects.

=item C<< node.do_action(action) >>, C<< node.do_action_on_child(child, action) >>

Parameters: C<action> is a path action and C<child> is a child node.
Returns: value. Applies path mutation actions.

=item C<< node.ref() >>, C<< node.ref_on_child(child) >>

Parameters: C<child> is a child node where required. Returns:
C<Function>. Returns a reference-like getter/setter.

=back

=item C<SimpleNode>, C<StringNode>, C<NumberNode>, C<BooleanNode>, C<NullNode>

Scalar node wrappers. They inherit the C<Node> API and override
C<type>, C<string_value>, or C<number_value> where appropriate.

=item C<ArrayNode>, C<SetNode>, C<BagNode>, C<DictNode>, C<PairListNode>, C<PairNode>

Collection node wrappers. They inherit the C<Node> API and override
child, attribute, assignment, and reference methods appropriate to their
collection type. PairList children are C<PairNode> objects in pair order;
C<indexed_child> uses global pair index, while C<named_indexed_child> uses
the occurrence index among pairs with the same key.

=item C<KDLDocumentNode>, C<KDLNodeNode>, C<KDLValueNode>

KDL node wrappers. They inherit the C<Node> API and expose KDL children,
attributes, names, value tags, and scalar coercions.

=item C<XmlNodeNode>

XML node wrapper. It inherits the C<Node> API and exposes XML names,
children, attributes, sibling traversal, and scalar text values.

=item C<TimeNode>

C<std/time> wrapper. It inherits the C<Node> API and exposes time
attributes plus string and numeric values.

=item C<PathNode>

C<std/io> path wrapper. It inherits the C<Node> API and exposes path
attributes plus string values.

=item C<WidgetNode>

C<std/gui/objects> widget wrapper. It inherits the C<Node> API and
exposes widget children by widget class name and index, plus public
widget properties as assignable attributes.

=back

=head2 Variables

=over

=item C<determine_class>

Type: C<Function>. Chooses the concrete node wrapper class for a raw
value.

=back

=head1 COPYRIGHT AND LICENCE

B<< std/path/z/node >> is copyright Toby Inkster.

It is free software; you may redistribute it and/or modify it under
the terms of either the Artistic License 1.0 or the GNU General Public
License version 2.

=cut

from std/data/cbor import TaggedValue;
from std/data/kdl import KDLDocument, KDLNode, KDLValue;
from std/internals import class_name, load_module, ref_id;
from std/io try import Path;
from std/math import Math;
from std/string import substr;
from std/time import Time;


function determine_class;
let _widget_class_loaded := false;
let _widget_class := null;

const _WIDGET_ATTRS := [
	{ name: "id", getter: "id", setter: "set_id" },
	{ name: "enabled", getter: "enabled", setter: "set_enabled" },
	{ name: "visible", getter: "visible", setter: "set_visible" },
	{ name: "width", getter: "width", accessor: true },
	{ name: "height", getter: "height", accessor: true },
	{ name: "minwidth", getter: "minwidth", accessor: true },
	{ name: "minheight", getter: "minheight", accessor: true },
	{ name: "maxwidth", getter: "maxwidth", accessor: true },
	{ name: "maxheight", getter: "maxheight", accessor: true },
	{ name: "classes", getter: "classes" },
	{ name: "title", getter: "title", setter: "set_title", accessor: true },
	{ name: "text", getter: "text", setter: "set_text", accessor: true },
	{ name: "value", getter: "value", setter: "set_value", accessor: true },
	{ name: "placeholder", getter: "placeholder", setter: "set_placeholder", accessor: true },
	{ name: "for", getter: "for_id", setter: "set_for_id", accessor: true },
	{ name: "align", getter: "align", accessor: true },
	{ name: "gap", getter: "gap", accessor: true },
	{ name: "padding", getter: "padding", accessor: true },
	{ name: "label", getter: "label", accessor: true },
	{ name: "collapsible", getter: "collapsible", accessor: true },
	{ name: "collapsed", getter: "collapsed", accessor: true },
	{ name: "wrap", getter: "wrap", accessor: true },
	{ name: "readonly", getter: "readonly", accessor: true },
	{ name: "multiline", getter: "multiline", accessor: true },
	{ name: "password", getter: "password", accessor: true },
	{ name: "required", getter: "required", accessor: true },
	{ name: "src", getter: "src", accessor: true },
	{ name: "alt", getter: "alt", accessor: true },
	{ name: "fit", getter: "fit", accessor: true },
	{ name: "checked", getter: "checked", accessor: true },
	{ name: "indeterminate", getter: "indeterminate", accessor: true },
	{ name: "name", getter: "name", accessor: true },
	{ name: "disabled", getter: "disabled", accessor: true },
	{ name: "group", getter: "group", accessor: true },
	{ name: "multiple", getter: "multiple", accessor: true },
	{ name: "min", getter: "min", accessor: true },
	{ name: "max", getter: "max", accessor: true },
	{ name: "first_day_of_week", getter: "first_day_of_week", accessor: true },
	{ name: "orientation", getter: "orientation", accessor: true },
	{ name: "step", getter: "step", accessor: true },
	{ name: "show_text", getter: "show_text", accessor: true },
	{ name: "selected", getter: "selected", accessor: true },
	{ name: "placement", getter: "placement", accessor: true },
	{ name: "icon", getter: "icon", setter: "set_icon", accessor: true },
	{ name: "closable", getter: "closable", accessor: true },
	{ name: "selected_index", getter: "selected_index", accessor: true },
	{ name: "selected_path", getter: "selected_path", accessor: true },
	{ name: "variant", getter: "variant", accessor: true },
];

function _zpath_widget_class () {
	if ( not _widget_class_loaded ) {
		_widget_class_loaded := true;
		try {
			_widget_class := load_module( "std/gui/objects", "Widget" );
		}
		catch {
			_widget_class := null;
		}
	}
	return _widget_class;
}

function _zpath_is_widget ( obj ) {
	let Widget := _zpath_widget_class();
	return Widget ≢ null and obj instanceof Widget;
}

function _zpath_xml_node_type ( obj ) {
	return null if not( obj can nodeType );
	try {
		return int( "" _ obj.nodeType() );
	}
	catch {
	}
	return null;
}

function _zpath_is_xml_document ( obj ) {
	return true if _zpath_xml_node_type(obj) = 9;
	return false if not( obj can documentElement );
	try {
		obj.documentElement();
		return true;
	}
	catch {
	}
	return false;
}

function _zpath_is_xml_node ( obj ) {
	return true if _zpath_xml_node_type(obj) ≢ null;
	return _zpath_is_xml_document(obj);
}

function _zpath_widget_attr_name ( name ) {
	return ( name ~ /^@/ ) ? substr( name, 1 ) : name;
}

function _zpath_widget_attr_spec ( name ) {
	let attr := _zpath_widget_attr_name(name);
	return _WIDGET_ATTRS.first( fn spec → spec{name} ≡ attr );
}

function _zpath_widget_attr_applies ( widget, spec ) {
	let attr := spec{name};
	if ( attr in [
		"id",
		"enabled",
		"visible",
		"width",
		"height",
		"minwidth",
		"minheight",
		"maxwidth",
		"maxheight",
		"classes",
	] ) {
		return true;
	}

	switch ( class_name(widget) : eq ) {
		case "Window":
			return attr in [ "title" ];
		case "VBox", "HBox":
			return attr in [ "align", "gap", "padding" ];
		case "Frame":
			return attr in [ "label", "collapsible", "collapsed" ];
		case "Label":
			return attr in [ "text", "for" ];
		case "Text":
			return attr in [ "value", "multiline", "readonly", "wrap" ];
		case "RichText":
			return attr in [ "value", "multiline", "readonly" ];
		case "Image":
			return attr in [ "src", "alt", "fit" ];
		case "Input":
			return attr in [
				"value",
				"placeholder",
				"multiline",
				"readonly",
				"password",
				"required",
			];
		case "DatePicker":
			return attr in [ "value", "min", "max", "first_day_of_week" ];
		case "Checkbox":
			return attr in [ "label", "checked", "indeterminate" ];
		case "Radio":
			return attr in [ "label", "value", "group", "checked" ];
		case "RadioGroup":
			return attr in [ "name", "value" ];
		case "Select":
			return attr in [ "value", "multiple" ];
		case "Menu":
			return attr in [ "text" ];
		case "MenuItem":
			return attr in [ "text", "disabled" ];
		case "Button":
			return attr in [ "text", "variant" ];
		case "Separator":
			return attr in [ "orientation" ];
		case "Slider":
			return attr in [ "value", "min", "max", "step", "orientation", "readonly" ];
		case "Progress":
			return attr in [ "value", "min", "max", "indeterminate", "show_text" ];
		case "Tabs":
			return attr in [ "selected", "placement" ];
		case "Tab":
			return attr in [ "title", "value", "icon", "selected", "closable" ];
		case "ListView":
			return attr in [ "selected_index", "multiple" ];
		case "TreeView":
			return attr in [ "selected_path", "multiple" ];
	}

	return false;
}

function _zpath_widget_get_attr ( widget, spec ) {
	let getter := spec{getter};
	return widget.(getter)();
}

function _zpath_widget_set_attr ( widget, spec, value ) {
	let setter := spec.get( "setter", null );
	if ( setter ≢ null ) {
		try {
			return widget.(setter)(value);
		}
		catch {
		}
	}

	let getter := spec{getter};
	if ( spec.get( "accessor", false ) ) {
		try {
			return widget.(getter)(value);
		}
		catch {
		}
	}

	die `Widget attribute @${spec{name}} is not assignable`;
}

class Node {
	let raw with set := null;
	let parent but weak := null;
	let _parent_keepalive := null;
	let key := null;
	let id := null;
	let ix := null;
	let tagged with set, has := null;

	static method _xml_node_type_code ( value ) {
		try {
			return int( "" _ value.nodeType() );
		}
		catch {
			return null;
		}
	}

	static method from_root ( obj ) {
		return self.wrap(obj);
	}

	static method wrap ( _obj, parent?, key?, ix? ) {
		
		let obj := _obj;

		if ( obj instanceof Node ) {
			return obj;
		}

		let Klass := determine_class( obj );
		
		let n := new Klass(
			raw: obj,
			parent: parent,
			key: key,
			ix: ix,
		);
		
		if ( obj instanceof TaggedValue ) {
			n.set_tagged(obj);
			while ( obj instanceof TaggedValue ) {
				obj := obj{value}
			}
			n.set_raw(obj);
		}
		
		n._build_id_with_parent(parent);
		
		return n;
	}

	method hold_parent ( owner ) {
		_parent_keepalive := owner;
		return self;
	}
	
	method _use_ref_as_id () {
		return false;
	}
	
	method _build_id () {
		id := self._generate_id;
	}

	method _build_id_with_parent ( owner ) {
		id := self._generate_id_with_parent(owner);
	}
	
	method _generate_id () {
		return self._generate_id_with_parent(parent);
	}

	method _generate_id_with_parent ( owner ) {
		
		if ( self._use_ref_as_id ) {
			return "ref:" _ ref_id(raw);
		}
		
		if ( owner ≡ null ) {
			return "root";
		}
		
		if ( ix ≢ null ) {
			if ( key ≢ null ) {
				return owner.id _ "/" _ key _ "#" _ ix;
			}
			return owner.id _ "/#" _ ix;
		}
		
		if ( key ≢ null ) {
			return owner.id _ "/" _ key;
		}
		
		return "rand:" _ floor( 1000 * 1000 * 1000 * Math.rand() );
	}
	
	method raw ()    { return raw; }
	method parent () { return parent; }
	method key ()    { return key; }
	method id ()     { return id; }
	method ix ()     { return ix; }
	method index ()  { return ix; }
	method tagged () { return tagged; }

	method type () {
		return typeof raw;
	}

	method value () {
		return raw;
	}

	method primitive_value () {
		return raw;
	}

	method string_value () {
		let p := self.primitive_value;
		return p ≡ null ? null : "" _ p;
	}

	method number_value () {
		let v := self.primitive_value();
		return 0 + v if v ~ /^-?(?:[0-9]+(?:\.[0-9]+)?|\.[0-9]+)$/;
		return null;
	}

	method can_have_named_children () {
		return false;
	}

	method can_have_indexed_children () {
		return false;
	}

	method can_have_named_indexed_children () {
		return false;
	}

	method named_child ( name ) {
		self.children.first( fn kid → kid.key ≡ name );
	}

	method indexed_child ( i ) {
		self.children.first( fn kid → kid.ix ≡ i );
	}
	
	method named_indexed_child ( name, i ) {
		self.children.first( fn kid → kid.ix ≡ i and kid.key ≡ name );
	}
	
	method next_child ( child ) {
		let i := child.ix;
		return null if i ≡ null; 
		return self.indexed_child( i + 1 );
	}

	method prev_child ( child ) {
		let i := child.ix;
		return null if i ≡ null; 
		return null if i = 0;
		return self.indexed_child( i - 1 );
	}

	method next_sibling () {
		return self.parent.next_child( self );
	}

	method prev_sibling () {
		return self.parent.prev_child( self );
	}

	method named_attribute ( name ) {
		let attrname := ( name ~ /^@/ ) ? name : `@${name}`;
		self.attributes.first( fn kid → kid.name ≡ attrname );
	}

	method children () {
		return [];
	}

	method attributes () {
		return [];
	}
	
	method name () {
		return key;
	}

	method dump () {
		return {
			"@type": self.type(),
			"@id": self.id(),
			"@key": self.key(),
			"@index": self.index(),
			"@value": self.primitive_value(),
			children: self.children().map( fn c -> c.dump() ),
			attributes: self.attributes().map( fn a -> a.dump() ),
		};
	}

	method find ( zpath ) {
		from std/path/z import ZPath;

		die "Node.find expects a ZPath object"
			unless zpath instanceof ZPath;

		return zpath.evaluate(self);
	}

	method do_action ( action ) {
		const container_node := self.parent();
		die "Path assignment target has no parent node"
			if container_node ≡ null;
		return container_node.do_action_on_child( self, action );
	}

	method ref () {
		const container_node := self.parent();
		die "Path assignment target has no parent node"
			if container_node ≡ null;
		return container_node.ref_on_child(self);
	}

	method do_action_on_child ( child, action ) {
		die `Path assignment target container '${self.type()}' is not assignable`;
	}

	method ref_on_child ( child ) {
		die `Path assignment target container '${self.type()}' is not assignable`;
	}
}

class SimpleNode extends Node {
}

class StringNode extends SimpleNode {
	
	method string_value () {
		let raw := self.raw;
		if ( raw instanceof BinaryString ) {
			return to_string( raw );
		}
		return raw;
	}
	
	method type () {
		return "string";
	}
}

class NumberNode extends SimpleNode {
	method number_value () {
		let raw := self.raw;
		return raw;
	}
	
	method type () {
		return "number";
	}
}

class BooleanNode extends SimpleNode {
	method type () {
		return "boolean";
	}
}

class NullNode extends SimpleNode {
	method type () {
		return "null";
	}
}

class ArrayNode extends Node {

	method _use_ref_as_id () {
		return true;
	}
	
	method type () {
		return "list";
	}
	
	method children () {
		let raw := self.raw;
		let out := [];
		let i := 0;
		while ( i < raw.length ) {
			let child := Node.wrap( raw[i], self, null, i );
			out.push(child);
			i++;
		}
		return out;
	}
	
	method can_have_indexed_children () {
		return false;
	}

	method do_action_on_child ( child, action ) {
		return super( child, action ) if action{op} ne ":=";

		const ix := child.ix();
		die "Path assignment expects numeric array index" if ix ≡ null;
		let container := self.raw();
		container[ix] := action{value};
		return action{value};
	}

	method ref_on_child ( child ) {
		const ix := child.ix();
		die "Path assignment expects numeric array index" if ix ≡ null;
		let container := self.raw();
		return \ container[ix];
	}
}

class SetNode extends Node {
	
	method _use_ref_as_id () {
		return true;
	}

	method children () {
		let raw := self.raw;
		let out := [];
		let i := 0;
		while ( i < raw.length ) {
			let child := Node.wrap( raw[i], self, null, null );
			out.push(child);
			i++;
		}
		return out;
	}
}

class BagNode extends Node {
	
	method _use_ref_as_id () {
		return true;
	}

	method children () {
		let raw := self.raw;
		let out := [];
		let i := 0;
		while ( i < raw.length ) {
			let child := Node.wrap( raw[i], self, null, null );
			out.push(child);
			i++;
		}
		return out;
	}
}

class DictNode extends Node {

	method _use_ref_as_id () {
		return true;
	}
	
	method type () {
		return "map";
	}
	
	method children () {
		let raw := self.raw;
		let out := [];
		for ( let k in raw.keys() ) {
			let child := Node.wrap( raw.get(k), self, k );
			out.push(child);
		}
		return out;
	}
	
	method can_have_named_children () {
		return true;
	}

	method do_action_on_child ( child, action ) {
		return super( child, action ) if action{op} ne ":=";

		const key := child.key();
		die "Path assignment expects string dict key" if key ≡ null;
		let container := self.raw();
		container{(key)} := action{value};
		return action{value};
	}

	method ref_on_child ( child ) {
		const key := child.key();
		die "Path assignment expects string dict key" if key ≡ null;
		let container := self.raw();
		return \ container{(key)};
	}
}

class PairListNode extends Node {
	
	method _use_ref_as_id () {
		return true;
	}
	
	method children () {
		let raw := self.raw;
		let pairs := raw.to_Array();
		let out := [];
		let i := 0;
		while ( i < pairs.length() ) {
			let pair := pairs[i];
			out.push( Node.wrap( pair, self, pair.key, i ) );
			i++;
		}
		return out;
	}
	
	method can_have_named_children () {
		return true;
	}
	
	method can_have_indexed_children () {
		return true;
	}
	
	method can_have_named_indexed_children () {
		return true;
	}

	method named_child ( name ) {
		return self.named_indexed_child( name, 0 );
	}

	method indexed_child ( i ) {
		let pairs := self.raw().to_Array();
		return null if i < 0 or i >= pairs.length();
		let pair := pairs[i];
		return Node.wrap( pair, self, pair.key, i );
	}

	method named_indexed_child ( name, i ) {
		let pairs := self.raw().to_Array();
		let seen := 0;
		let pos := 0;
		while ( pos < pairs.length() ) {
			let pair := pairs[pos];
			if ( pair.key ≡ name ) {
				if ( seen = i ) {
					return Node.wrap( pair, self, pair.key, pos );
				}
				seen++;
			}
			pos++;
		}
		return null;
	}

	method _replace_value_at ( pair_ix, value ) {
		let container := self.raw();
		let pairs := container.to_Array();
		die "Path assignment expects numeric pairlist index"
			if pair_ix ≡ null or pair_ix < 0 or pair_ix >= pairs.length();

		container.clear();
		let i := 0;
		while ( i < pairs.length() ) {
			let pair := pairs[i];
			container.add( pair.key, i = pair_ix ? value : pair.value );
			i++;
		}
		return value;
	}

	method do_action_on_child ( child, action ) {
		return super( child, action ) if action{op} ne ":=";

		return self._replace_value_at( child.ix(), action{value} );
	}

	method ref_on_child ( child ) {
		let pair_ix := child.ix();
		return function ( ... args ) {
			let current := self.indexed_child(pair_ix);
			die "Path assignment target pairlist entry no longer exists"
				if current ≡ null;
			return current.raw().value if args.length() = 0;
			return self._replace_value_at( pair_ix, args[0] );
		};
	}
}

class PairNode extends Node {
	
	method attributes () {
		let raw := self.raw;
		return [ "key", "value" ]
			.map( fn a → Node.wrap( raw.(a)(), self, `@${a}` ) );
	}

	method do_action_on_child ( child, action ) {
		return super( child, action ) if action{op} ne ":=";
		return super( child, action ) if child.key() ne "@value";

		let container := self.parent();
		return super( child, action )
			if container ≡ null or not ( container instanceof PairListNode );
		return container.do_action_on_child( self, action );
	}

	method ref_on_child ( child ) {
		return super(child) if child.key() ne "@value";

		let container := self.parent();
		return super(child)
			if container ≡ null or not ( container instanceof PairListNode );
		return container.ref_on_child(self);
	}
}

class KDLDocumentNode extends Node {

	method _use_ref_as_id () {
		return true;
	}

	method type () {
		return "document";
	}

	method children () {
		let raw := self.raw;
		let out := [];
		let i := 0;
		while ( i < raw.nodes().length() ) {
			let child := raw.nodes()[i];
			out.push( Node.wrap( child, self, child.name(), i ) );
			i++;
		}
		return out;
	}

	method can_have_named_children () {
		return true;
	}

	method can_have_indexed_children () {
		return true;
	}

	method can_have_named_indexed_children () {
		return true;
	}

	method indexed_child ( i ) {
		return self.children().get( i, null );
	}

	method named_indexed_child ( name, i ) {
		let n := 0;
		for ( let child in self.children() ) {
			if ( child.key() ≡ name ) {
				return child if n ≡ i;
				n++;
			}
		}
		return null;
	}
}

class KDLNodeNode extends Node {

	method _use_ref_as_id () {
		return true;
	}

	method type () {
		return "element";
	}

	method name () {
		return self.raw().name();
	}

	method children () {
		let raw := self.raw;
		let out := [];
		let i := 0;
		for ( let arg in raw.args() ) {
			out.push( Node.wrap( arg, self, null, i ) );
			i++;
		}
		for ( let child in raw.children() ) {
			out.push( Node.wrap( child, self, child.name(), i ) );
			i++;
		}
		return out;
	}

	method attributes () {
		let raw := self.raw;
		let out := [];
		let i := 0;
		for ( let pair in raw.props().to_Array() ) {
			out.push( Node.wrap( pair.value, self, "@" _ pair.key, i ) );
			i++;
		}
		return out;
	}

	method can_have_named_children () {
		return true;
	}

	method can_have_indexed_children () {
		return true;
	}

	method can_have_named_indexed_children () {
		return true;
	}

	method indexed_child ( i ) {
		return self.children().get( i, null );
	}

	method named_indexed_child ( name, i ) {
		let n := 0;
		for ( let child in self.children() ) {
			if ( child.key() ≡ name ) {
				return child if n ≡ i;
				n++;
			}
		}
		return null;
	}
}

class KDLValueNode extends Node {

	method type () {
		return self.raw().type();
	}

	method value () {
		return self.raw().native_value();
	}

	method primitive_value () {
		return self.raw().native_value();
	}

	method string_value () {
		return self.raw().to_String();
	}

	method number_value () {
		try {
			return self.raw().to_Number();
		}
		catch {
			return null;
		}
	}

	method has_tagged () {
		return true;
	}

	method tagged () {
		let ann := self.raw().type_annotation();
		return {
			tag: ann ≡ null ? null : "" _ ann,
			value: self.raw().native_value(),
		};
	}
}

class XmlNodeNode extends Node {

	method _generate_id () {
		return
			try {
				let i := self.raw.unique_id;
				i ≡ null ? super() : `xml:${i}`;
			}
			catch {
				super();
			};
	}

	method type () {
		let raw := self.raw;
		if ( _zpath_is_xml_document(raw) ) {
			return "document";
		}
		switch ( Node._xml_node_type_code(raw) ) {
			case 1:
				return "element";
			case 2, 18:
				return "attr";
			case 3, 4:
				return "text";
			case 8:
				return "comment";
			case 9:
				return "document";
		}
		
		return super();
	}
	
	method name () {
		let raw := self.raw;
		switch ( Node._xml_node_type_code(raw) ) {
			case 1:
				return raw.nodeName();
			case 2, 18:
				return "@" _ raw.nodeName();
			case 3, 4:
				return "#text";
		}
		
		return super();
	}

	method next_child ( child ) {
		return child.next_sibling;
	}

	method prev_child ( child ) {
		return child.prev_sibling;
	}

	method next_sibling () {
		let x := self.raw.nextSibling;
		return null if x ≡ null;
		return Node.wrap( x, self.parent, x.nodeName );
	}

	method prev_sibling () {
		let x := self.raw.previousSibling;
		return null if x ≡ null;
		return Node.wrap( x, self.parent, x.nodeName );
	}

	method primitive_value () {
		let raw := self.raw;
		if ( _zpath_is_xml_document(raw) ) {
			let de := raw.documentElement();
			return de ≡ null ? null : de.textContent();
		}
		switch ( Node._xml_node_type_code(raw) ) {
			case 1:
				return raw.textContent;
			case 2, 18:
				return raw.nodeValue();
			case 3, 4, 8:
				return raw.data;
			case 9:
				let de := raw.documentElement();
				return de ≡ null ? null : de.textContent();
		}
		
		return super();
	}
	
	method string_value () {
		let raw := self.raw;
		if ( _zpath_is_xml_document(raw) ) {
			let de := raw.documentElement();
			return de ≡ null ? null : de.textContent();
		}
		switch ( Node._xml_node_type_code(raw) ) {
			case 1:
				return raw.textContent;
			case 2, 18:
				return raw.nodeValue();
			case 3, 4, 8:
				return raw.data;
			case 9:
				let de := raw.documentElement();
				return de ≡ null ? null : de.textContent();
		}

		return super();
	}

	method can_have_named_children () {
		return true;
	}
	
	method can_have_indexed_children () {
		return true;
	}
	
	method can_have_named_indexed_children () {
		return true;
	}
	
	method children () {
		let raw := self.raw;
		if ( _zpath_is_xml_document(raw) ) {
			let de := raw.documentElement();
			return de ≡ null ? []
				: [ Node.wrap( de, self, de.nodeName(), 0 ) ];
		}
		let node_type := Node._xml_node_type_code(raw);
		if ( node_type = 9 ) {
			let de := raw.documentElement();
			return de ≡ null ? []
				: [ Node.wrap( de, self, de.nodeName(), 0 ) ];
		}

		if ( node_type = 1 ) {
			let kids := [];
			let count := {};
			for ( let child in raw.childNodes() ) {
				let nm := child.nodeName();
				let n := count.exists(nm) ? count.get( nm ) : 0;
				count.set( nm, n + 1 );
				kids.push( Node.wrap( child, self, nm, n ) );
			}
			return kids;
		}

		return [];
	}

	method attributes () {
		let raw := self.raw;
		let out := super();
		if ( Node._xml_node_type_code(raw) ≡ 1 ) {
			for ( let attr in raw.attributes() ) {
				let n := Node.wrap( attr, self, "@" _ attr.nodeName() );
				out.push(n);
			}
		}
		return out;
	}
}

class TimeNode extends Node {
	
	method string_value () {
		let raw := self.raw;
		return raw.datetime;
	}
	
	method number_value () {
		let raw := self.raw;
		return raw.epoch;
	}
	
	method attributes () {
		let raw := self.raw;
		return [ "year", "month", "day", "hour", "min", "sec" ]
			.map( fn a → Node.wrap( raw.(a)(), self, `@${a}` ) );
	}
}

class PathNode extends Node {

	method string_value () {
		let raw := self.raw;
		return raw.to_String;
	}
	
	method attributes () {
		let raw := self.raw;
		if ( raw.is_file ) {
			const stat := raw.stat;
			return stat.keys.map( fn a → Node.wrap( stat{a}, self, `@${a}` ) );
		}
		
		return super();
	}
}

class WidgetNode extends Node {

	method _use_ref_as_id () {
		return true;
	}

	method type () {
		return "widget";
	}

	method name () {
		return class_name( self.raw() ) ?: "Widget";
	}

	method can_have_named_children () {
		return true;
	}

	method can_have_indexed_children () {
		return true;
	}

	method can_have_named_indexed_children () {
		return true;
	}

	method children () {
		let out := [];
		let i := 0;
		for ( let child in self.raw().children() ) {
			let nm := class_name(child) ?: "Widget";
			out.push( Node.wrap( child, self, nm, i ) );
			i++;
		}
		return out;
	}

	method indexed_child ( i ) {
		return self.children().get( i, null );
	}

	method named_indexed_child ( name, i ) {
		let n := 0;
		for ( let child in self.children() ) {
			if ( child.key() ≡ name ) {
				return child if n ≡ i;
				n++;
			}
		}
		return null;
	}

	method attributes () {
		let raw := self.raw();
		let out := [];
		let i := 0;
		for ( let spec in _WIDGET_ATTRS ) {
			next unless _zpath_widget_attr_applies( raw, spec );
			try {
				let value := _zpath_widget_get_attr( raw, spec );
				out.push( Node.wrap( value, self, "@" _ spec{name}, i ) );
				i++;
			}
			catch {
			}
		}
		return out;
	}

	method do_action_on_child ( child, action ) {
		return super( child, action ) if action{op} ne ":=";

		let spec := _zpath_widget_attr_spec( child.key() );
		return super( child, action ) if spec ≡ null;

		_zpath_widget_set_attr( self.raw(), spec, action{value} );
		return action{value};
	}

	method ref_on_child ( child ) {
		let spec := _zpath_widget_attr_spec( child.key() );
		return super(child) if spec ≡ null;

		let widget := self.raw();
		return function ( ... args ) {
			if ( args.length() = 0 ) {
				return _zpath_widget_get_attr( widget, spec );
			}
			_zpath_widget_set_attr( widget, spec, args[0] );
			return args[0];
		};
	}
}

// Need to define the body of this function late so it can refer back to
// classes that have been declared.

function determine_class ( obj ) {
	let Klass;
	
	let real_obj := obj;
	while ( real_obj instanceof TaggedValue ) {
		real_obj := real_obj{value};
	}
	
	if ( real_obj instanceof Null ) {
		Klass := NullNode;
	}
	else if ( real_obj instanceof Boolean ) {
		Klass := BooleanNode;
	}
	else if ( real_obj instanceof Number ) {
		Klass := NumberNode;
	}
	else if ( real_obj instanceof String or real_obj instanceof BinaryString ) {
		Klass := StringNode;
	}
	else if ( real_obj instanceof Array ) {
		Klass := ArrayNode;
	}
	else if ( real_obj instanceof Bag ) {
		Klass := BagNode;
	}
	else if ( real_obj instanceof Set ) {
		Klass := SetNode;
	}
	else if ( real_obj instanceof Dict ) {
		Klass := DictNode;
	}
	else if ( real_obj instanceof PairList ) {
		Klass := PairListNode;
	}
	else if ( real_obj instanceof Pair ) {
		Klass := PairNode;
	}
	else if ( real_obj instanceof KDLDocument ) {
		Klass := KDLDocumentNode;
	}
	else if ( real_obj instanceof KDLNode ) {
		Klass := KDLNodeNode;
	}
	else if ( real_obj instanceof KDLValue ) {
		Klass := KDLValueNode;
	}
	else if ( _zpath_is_xml_node(real_obj) ) {
		Klass := XmlNodeNode;
	}
	else if ( real_obj instanceof Time ) {
		Klass := TimeNode;
	}
	else if ( Path and ( real_obj instanceof Path ) ) {
		Klass := PathNode;
	}
	else if ( real_obj instanceof Object ) {
		if ( real_obj can __zpath_node_class__ ) {
			Klass = real_obj.__zpath_node_class__;
		}
	}

	if ( Klass ≡ null and _zpath_is_widget(real_obj) ) {
		Klass := WidgetNode;
	}

	if ( Klass ≡ null ) {
		Klass := XmlNodeNode if _zpath_is_xml_node(real_obj);
	}
	
	return Klass ?: Node;
}