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
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
|
# JavaScript binding generator. Horrifying, I know. But it works!
# Warning: Function overloading is currently not implemented. Though there is a
# block dielabel:
# ...
# around each bound function call, so it shouldn't be too difficult to get it
# working. (This would involve generating JS functions in registerType.)
# Now for the pragmas:
# {.jsctor.} for constructors. These need no `this' value, and are bound as
# regular constructors in JS. They must return a ref object, which will have
# a JS counterpart too. (Other functions can return ref objects too, which
# will either use the existing JS counterpart, if exists, or create a new
# one. In other words: cross-language reference semantics work seamlessly.)
# {.jsfunc.} is used for binding normal functions. Needs a `this' value, as all
# following pragmas. As mentioned before, overloading doesn't work but OR
# generics do. Bare objects (returned by value) can't be passed either, for
# now. Otherwise, most types should work.
# {.jsget.}, {.jsfget.} must be specified on object fields; these generate
# regular getter & setter functions.
# {.jsufget, jsuffget, jsuffunc.} For fields with the [LegacyUnforgeable]
# WebIDL property.
# This makes it so a non-configurable/writable, but enumerable property
# is defined on the object when the *constructor* is called (i.e. NOT on
# the prototype.)
# {.jsfget.} and {.jsfset.} for getters/setters. Note the `f'; bare jsget/jsset
# can only be used on object fields. (I initially wanted to use the same
# keyword, unfortunately that didn't work out.)
# {.jsgetprop.} for property getters. Called when GetOwnProperty would return
# nothing. The key should probably be either a string or an integer.
# {.jssetprop.} for property setters. Called on SetProperty - in fact this
# is the set() method of Proxy, except it always returns true. Same rules as
# jsgetprop for keys.
# {.jsdelprop.} for property deletion. It is like the deleteProperty method
# of Proxy. Must return true if deleted, false if not deleted.
# {.jshasprop.} for overriding has_property. Must return a boolean.
# {.jspropnames.} overrides get_own_property_names. Must return a
# JSPropertyEnumList object.
import macros
import options
import sets
import streams
import strformat
import strutils
import tables
import unicode
import js/error
import js/fromjs
import js/opaque
import js/tojs
import js/typeptr
import types/opt
import bindings/quickjs
export opt
export options
export tables
export
JS_NULL, JS_UNDEFINED, JS_FALSE, JS_TRUE, JS_EXCEPTION, JS_UNINITIALIZED
export
JS_EVAL_TYPE_GLOBAL,
JS_EVAL_TYPE_MODULE,
JS_EVAL_TYPE_DIRECT,
JS_EVAL_TYPE_INDIRECT,
JS_EVAL_TYPE_MASK,
JS_EVAL_FLAG_SHEBANG,
JS_EVAL_FLAG_STRICT,
JS_EVAL_FLAG_STRIP,
JS_EVAL_FLAG_COMPILE_ONLY
export JSRuntime, JSContext, JSValue, JSClassID
export
JS_GetGlobalObject, JS_FreeValue, JS_IsException, JS_GetPropertyStr,
JS_IsFunction, JS_NewCFunctionData, JS_Call, JS_DupValue
when sizeof(int) < sizeof(int64):
export quickjs.`==`
type
JSFunctionList = openArray[JSCFunctionListEntry]
BoundFunction = object
t: BoundFunctionType
name: string
id: NimNode
magic: uint16
unforgeable: bool
isstatic: bool
BoundFunctionType = enum
FUNCTION = "js_func"
CONSTRUCTOR = "js_ctor"
GETTER = "js_get"
SETTER = "js_set"
PROPERTY_GET = "js_prop_get"
PROPERTY_SET = "js_prop_set"
PROPERTY_DEL = "js_prop_del"
PROPERTY_HAS = "js_prop_has"
PROPERTY_NAMES = "js_prop_names"
FINALIZER = "js_fin"
var runtimes {.threadvar.}: seq[JSRuntime]
proc newJSRuntime*(): JSRuntime =
let rt = JS_NewRuntime()
let opaque = JSRuntimeOpaque()
GC_ref(opaque)
JS_SetRuntimeOpaque(rt, cast[pointer](opaque))
# Must be added after opaque is set, or there is a chance of
# nim_finalize_for_js dereferencing it (at the new call).
runtimes.add(rt)
return rt
proc newJSContext*(rt: JSRuntime): JSContext =
let ctx = JS_NewContext(rt)
let opaque = newJSContextOpaque(ctx)
GC_ref(opaque)
JS_SetContextOpaque(ctx, cast[pointer](opaque))
return ctx
func getClass*(ctx: JSContext, class: string): JSClassID =
# This function *should* never fail.
ctx.getOpaque().creg[class]
func hasClass*(ctx: JSContext, class: type): bool =
return $class in ctx.getOpaque().creg
func newJSCFunction*(ctx: JSContext, name: string, fun: JSCFunction,
argc: int = 0, proto = JS_CFUNC_generic, magic = 0): JSValue =
return JS_NewCFunction2(ctx, fun, cstring(name), cint(argc), proto, cint(magic))
proc free*(ctx: var JSContext) =
var opaque = ctx.getOpaque()
if opaque != nil:
for a in opaque.sym_refs:
JS_FreeAtom(ctx, a)
for a in opaque.str_refs:
JS_FreeAtom(ctx, a)
for classid, v in opaque.ctors:
JS_FreeValue(ctx, v)
JS_FreeValue(ctx, opaque.Array_prototype_values)
JS_FreeValue(ctx, opaque.Object_prototype_valueOf)
JS_FreeValue(ctx, opaque.Uint8Array_ctor)
for v in opaque.err_ctors:
JS_FreeValue(ctx, v)
GC_unref(opaque)
JS_FreeContext(ctx)
ctx = nil
proc free*(rt: var JSRuntime) =
let opaque = rt.getOpaque()
GC_unref(opaque)
JS_FreeRuntime(rt)
runtimes.del(runtimes.find(rt))
rt = nil
proc setGlobal*[T](ctx: JSContext, global: JSValue, obj: T) =
# Add JSValue reference.
let p = JS_VALUE_GET_PTR(global)
let header = cast[ptr JSRefCountHeader](p)
inc header.ref_count
ctx.setOpaque(global, cast[pointer](obj))
GC_ref(obj)
proc setInterruptHandler*(rt: JSRuntime, cb: JSInterruptHandler, opaque: pointer = nil) =
JS_SetInterruptHandler(rt, cb, opaque)
proc writeException*(ctx: JSContext, s: Stream) =
let ex = JS_GetException(ctx)
let str = fromJS[string](ctx, ex)
if str.isSome:
s.write(str.get & '\n')
let stack = JS_GetPropertyStr(ctx, ex, cstring("stack"));
if not JS_IsUndefined(stack):
let str = fromJS[string](ctx, stack)
if str.isSome:
s.write(str.get)
s.flush()
JS_FreeValue(ctx, stack)
JS_FreeValue(ctx, ex)
proc runJSJobs*(rt: JSRuntime, err: Stream) =
while JS_IsJobPending(rt):
var ctx: JSContext
let r = JS_ExecutePendingJob(rt, addr ctx)
if r == -1:
ctx.writeException(err)
# Add all LegacyUnforgeable functions defined on the prototype chain to
# the opaque.
# Since every prototype has a list of all its ancestor's LegacyUnforgeable
# functions, it is sufficient to simply merge the new list of new classes
# with their parent's list to achieve this.
proc addClassUnforgeable(ctx: JSContext, proto: JSValue,
classid, parent: JSClassID, ourUnforgeable: JSFunctionList) =
let ctxOpaque = ctx.getOpaque()
var merged = @ourUnforgeable
ctxOpaque.unforgeable.withValue(parent, uf):
merged.add(uf[])
if merged.len > 0:
ctxOpaque.unforgeable[classid] = merged
let ufp = addr ctxOpaque.unforgeable[classid][0]
JS_SetPropertyFunctionList(ctx, proto, ufp, cint(merged.len))
func newJSClass*(ctx: JSContext, cdef: JSClassDefConst, tname: string,
nimt: pointer, ctor: JSCFunction, funcs: JSFunctionList, parent: JSClassID,
asglobal: bool, nointerface: bool, finalizer: JSFinalizerFunction,
namespace: JSValue, errid: Opt[JSErrorEnum],
unforgeable, staticfuns: JSFunctionList,
ishtmldda: bool): JSClassID {.discardable.} =
let rt = JS_GetRuntime(ctx)
discard JS_NewClassID(addr result)
var ctxOpaque = ctx.getOpaque()
var rtOpaque = rt.getOpaque()
if JS_NewClass(rt, result, cdef) != 0:
raise newException(Defect, "Failed to allocate JS class: " & $cdef.class_name)
ctxOpaque.typemap[nimt] = result
ctxOpaque.creg[tname] = result
ctxOpaque.parents[result] = parent
if ishtmldda:
ctxOpaque.htmldda = result
if finalizer != nil:
rtOpaque.fins[result] = finalizer
var proto: JSValue
if parent != 0:
let parentProto = JS_GetClassProto(ctx, parent)
proto = JS_NewObjectProtoClass(ctx, parentProto, parent)
JS_FreeValue(ctx, parentProto)
else:
proto = JS_NewObject(ctx)
if funcs.len > 0:
# We avoid funcs being GC'ed by putting the list in rtOpaque.
# (QuickJS uses the pointer later.)
#TODO maybe put them in ctxOpaque instead?
rtOpaque.flist.add(@funcs)
JS_SetPropertyFunctionList(ctx, proto, addr rtOpaque.flist[^1][0], cint(funcs.len))
#TODO check if this is an indexed property getter
if cdef.exotic != nil and cdef.exotic.get_own_property != nil:
let val = JS_DupValue(ctx, ctxOpaque.Array_prototype_values)
doAssert JS_SetProperty(ctx, proto, ctxOpaque.sym_refs[ITERATOR], val) == 1
let toStringTag = ctxOpaque.sym_refs[TO_STRING_TAG]
let news = JS_NewString(ctx, cdef.class_name)
doAssert JS_SetProperty(ctx, proto, toStringTag, news) == 1
JS_SetClassProto(ctx, result, proto)
ctx.addClassUnforgeable(proto, result, parent, unforgeable)
if asglobal:
let global = JS_GetGlobalObject(ctx)
assert ctxOpaque.gclaz == ""
ctxOpaque.gclaz = tname
ctxOpaque.gparent = parent
if JS_SetPrototype(ctx, global, proto) != 1:
raise newException(Defect, "Failed to set global prototype: " &
$cdef.class_name)
# Global already exists, so set unforgeable functions here
ctxOpaque.unforgeable.withValue(result, uf):
JS_SetPropertyFunctionList(ctx, global, addr uf[][0], cint(uf[].len))
JS_FreeValue(ctx, global)
let jctor = ctx.newJSCFunction($cdef.class_name, ctor, 0, JS_CFUNC_constructor)
if staticfuns.len > 0:
rtOpaque.flist.add(@staticfuns)
JS_SetPropertyFunctionList(ctx, jctor, addr rtOpaque.flist[^1][0],
cint(staticfuns.len))
JS_SetConstructor(ctx, jctor, proto)
if errid.isSome:
ctx.getOpaque().err_ctors[errid.get] = JS_DupValue(ctx, jctor)
ctxOpaque.ctors[result] = JS_DupValue(ctx, jctor)
if not nointerface:
if JS_IsNull(namespace):
let global = JS_GetGlobalObject(ctx)
ctx.definePropertyCW(global, $cdef.class_name, jctor)
JS_FreeValue(ctx, global)
else:
ctx.definePropertyCW(namespace, $cdef.class_name, jctor)
type FuncParam = tuple[name: string, t: NimNode, val: Option[NimNode], generic: Option[NimNode]]
func getMinArgs(params: seq[FuncParam]): int =
for i in 0..<params.len:
let it = params[i]
if it[2].isSome:
return i
let t = it.t
if t.kind == nnkBracketExpr:
if t.typeKind == varargs.getType().typeKind:
assert i == params.high, "Not even nim can properly handle this..."
return i
return params.len
func fromJSP[T: string|uint32](ctx: JSContext, atom: JSAtom): Opt[T] =
return fromJS[T](ctx, atom)
proc getJSFunction*[T, U](ctx: JSContext, val: JSValue):
(proc(x: T): JSResult[U]) =
return fromJSFunction1[T, U](ctx, val)
proc defineConsts*[T](ctx: JSContext, classid: JSClassID,
consts: static openarray[(string, T)]) =
let proto = ctx.getOpaque().ctors[classid]
for (k, v) in consts:
ctx.definePropertyE(proto, k, v)
proc defineConsts*(ctx: JSContext, classid: JSClassID,
consts: typedesc[enum], astype: typedesc) =
let proto = ctx.getOpaque().ctors[classid]
for e in consts:
ctx.definePropertyE(proto, $e, astype(e))
type
JSFuncGenerator = object
t: BoundFunctionType
thisname: Option[string]
funcName: string
generics: Table[string, seq[NimNode]]
funcParams: seq[FuncParam]
passCtx: bool
thisType: string
thisTypeNode: NimNode
returnType: Option[NimNode]
newName: NimNode
newBranchList: seq[NimNode]
errval: NimNode # JS_EXCEPTION or -1
dielabel: NimNode # die: didn't match parameters, but could still match other ones
jsFunCallLists: seq[NimNode]
jsFunCallList: NimNode
jsFunCall: NimNode
jsCallAndRet: NimNode
minArgs: int
actualMinArgs: int # minArgs without JSContext
i: int # nim parameters accounted for
j: int # js parameters accounted for (not including fix ones, e.g. `this')
res: NimNode
unforgeable: bool
isstatic: bool
var BoundFunctions {.compileTime.}: Table[string, seq[BoundFunction]]
proc getGenerics(fun: NimNode): Table[string, seq[NimNode]] =
var node = fun.findChild(it.kind == nnkBracket)
if node.kind == nnkNilLit:
return # no bracket
node = node.findChild(it.kind == nnkGenericParams)
if node.kind == nnkNilLit:
return # no generics
node = node.findChild(it.kind == nnkIdentDefs)
var stack: seq[NimNode]
for i in countdown(node.len - 1, 0): stack.add(node[i])
var gen_name: NimNode
var gen_types: seq[NimNode]
template add_gen =
if gen_name != nil:
assert gen_types.len != 0
result[gen_name.strVal] = gen_types
gen_types.setLen(0)
while stack.len > 0:
let node = stack.pop()
case node.kind
of nnkIdent:
add_gen
gen_name = node
of nnkSym:
assert gen_name != nil
gen_types.add(node)
of nnkInfix:
assert node[0].eqIdent(ident("|")) or node[0].eqIdent(ident("or")), "Only OR generics are supported."
for i in countdown(node.len - 1, 1): stack.add(node[i]) # except infix ident
of nnkBracketExpr:
gen_types.add(node)
else:
discard
add_gen
proc getParams(fun: NimNode): seq[FuncParam] =
let formalParams = fun.findChild(it.kind == nnkFormalParams)
var funcParams: seq[FuncParam]
var returnType = none(NimNode)
if formalParams[0].kind != nnkEmpty:
returnType = some(formalParams[0])
for i in 1..<fun.params.len:
let it = formalParams[i]
let tt = it[^2]
var t: NimNode
if it[^2].kind != nnkEmpty:
t = `tt`
elif it[^1].kind != nnkEmpty:
let x = it[^1]
t = quote do:
typeof(`x`)
else:
error("?? " & treeRepr(it))
if t.kind in {nnkRefTy, nnkPtrTy}:
t = t[0]
let val = if it[^1].kind != nnkEmpty:
let x = it[^1]
some(newPar(x))
else:
none(NimNode)
var g = none(NimNode)
for i in 0 ..< it.len - 2:
let name = $it[i]
funcParams.add((name, t, val, g))
funcParams
proc getReturn(fun: NimNode): Option[NimNode] =
let formalParams = fun.findChild(it.kind == nnkFormalParams)
if formalParams[0].kind != nnkEmpty:
some(formalParams[0])
else:
none(NimNode)
template getJSParams(): untyped =
[
(quote do: JSValue),
newIdentDefs(ident("ctx"), quote do: JSContext),
newIdentDefs(ident("this"), quote do: JSValue),
newIdentDefs(ident("argc"), quote do: cint),
newIdentDefs(ident("argv"), quote do: ptr UncheckedArray[JSValue])
]
template getJSGetterParams(): untyped =
[
(quote do: JSValue),
newIdentDefs(ident("ctx"), quote do: JSContext),
newIdentDefs(ident("this"), quote do: JSValue),
]
template getJSGetPropParams(): untyped =
[
(quote do: cint),
newIdentDefs(ident("ctx"), quote do: JSContext),
newIdentDefs(ident("desc"), quote do: ptr JSPropertyDescriptor),
newIdentDefs(ident("obj"), quote do: JSValue),
newIdentDefs(ident("prop"), quote do: JSAtom),
]
template getJSSetPropParams(): untyped =
[
(quote do: cint),
newIdentDefs(ident("ctx"), quote do: JSContext),
newIdentDefs(ident("obj"), quote do: JSValue),
newIdentDefs(ident("atom"), quote do: JSAtom),
newIdentDefs(ident("value"), quote do: JSValue),
newIdentDefs(ident("receiver"), quote do: JSValue),
newIdentDefs(ident("flags"), quote do: cint),
]
template getJSDelPropParams(): untyped =
[
(quote do: cint),
newIdentDefs(ident("ctx"), quote do: JSContext),
newIdentDefs(ident("obj"), quote do: JSValue),
newIdentDefs(ident("prop"), quote do: JSAtom),
]
template getJSHasPropParams(): untyped =
[
(quote do: cint),
newIdentDefs(ident("ctx"), quote do: JSContext),
newIdentDefs(ident("obj"), quote do: JSValue),
newIdentDefs(ident("atom"), quote do: JSAtom),
]
template getJSSetterParams(): untyped =
[
(quote do: JSValue),
newIdentDefs(ident("ctx"), quote do: JSContext),
newIdentDefs(ident("this"), quote do: JSValue),
newIdentDefs(ident("val"), quote do: JSValue),
]
template getJSPropNamesParams(): untyped =
[
(quote do: cint),
newIdentDefs(ident("ctx"), quote do: JSContext),
newIdentDefs(ident("ptab"), quote do: ptr JSPropertyEnumArray),
newIdentDefs(ident("plen"), quote do: ptr uint32),
newIdentDefs(ident("obj"), quote do: JSValue)
]
template fromJS_or_return*(t, ctx, val: untyped): untyped =
(
let x = fromJS[t](ctx, val)
if x.isErr:
if x.error == nil:
return JS_EXCEPTION
return toJS(ctx, x.error)
x.get
)
template fromJSP_or_return*(t, ctx, val: untyped): untyped =
(
let x = fromJSP[t](ctx, val)
if x.isErr:
if x.error == nil:
return JS_EXCEPTION
return toJS(ctx, x.error)
x.get
)
template fromJS_or_die*(t, ctx, val, ev, dl: untyped): untyped =
let x = fromJSP[t](ctx, val)
if x.isNone:
break dl
x.get
proc addParam2(gen: var JSFuncGenerator, s, t, val: NimNode, fallback: NimNode = nil) =
let ev = gen.errval
let dl = gen.dielabel
let stmt = quote do:
fromJS_or_die(`t`, ctx, `val`, `ev`, `dl`)
for i in 0..gen.jsFunCallLists.high:
if fallback == nil:
gen.jsFunCallLists[i].add(newLetStmt(s, stmt))
else:
let j = gen.j
gen.jsFunCallLists[i].add(newLetStmt(s, quote do:
if `j` < argc and not JS_IsUndefined(argv[`j`]):
`stmt`
else:
`fallback`))
proc addValueParam(gen: var JSFuncGenerator, s, t: NimNode, fallback: NimNode = nil) =
let j = gen.j
gen.addParam2(s, t, quote do: argv[`j`], fallback)
proc addUnionParamBranch(gen: var JSFuncGenerator, query, newBranch: NimNode, fallback: NimNode = nil) =
let i = gen.i
let query = if fallback == nil: query else:
quote do: (`i` < argc and `query`)
let newBranch = newStmtList(newBranch)
for i in 0..gen.jsFunCallLists.high:
var ifstmt = newIfStmt((query, newBranch))
let oldBranch = newStmtList()
ifstmt.add(newTree(nnkElse, oldBranch))
gen.jsFunCallLists[i].add(ifstmt)
gen.jsFunCallLists[i] = oldBranch
gen.newBranchList.add(newBranch)
func isSequence*(ctx: JSContext, o: JSValue): bool =
if not JS_IsObject(o):
return false
let prop = JS_GetProperty(ctx, o, ctx.getOpaque().sym_refs[ITERATOR])
# prop can't be exception (throws_ref_error is 0 and tag is object)
result = not JS_IsUndefined(prop)
JS_FreeValue(ctx, prop)
proc addUnionParam0(gen: var JSFuncGenerator, tt: NimNode, s: NimNode, val: NimNode, fallback: NimNode = nil) =
# Union types.
#TODO quite a few types are still missing.
let flattened = gen.generics[tt.strVal] # flattened member types
var tableg = none(NimNode)
var seqg = none(NimNode)
var numg = none(NimNode)
var objg = none(NimNode)
var hasString = false
var hasJSValue = false
var hasBoolean = false
let ev = gen.errval
let dl = gen.dielabel
for g in flattened:
if g.len > 0 and g[0] == Table.getType():
tableg = some(g)
elif g.typekind == ntySequence:
seqg = some(g)
elif g == string.getTypeInst():
hasString = true
elif g == JSValue.getTypeInst():
hasJSValue = true
elif g == bool.getTypeInst():
hasBoolean = true
elif g == int.getTypeInst(): #TODO should be SomeNumber
assert numg.isNone
numg = some(g)
elif g == uint32.getTypeInst(): #TODO should be SomeNumber
assert numg.isNone
numg = some(g)
elif g.getTypeInst().getTypeImpl().kind == nnkRefTy:
# Assume it's ref object.
objg = some(g)
else:
error("Type not supported yet")
# 5. If V is a platform object, then:
if objg.isSome:
let t = objg.get
let x = ident("x")
let query = quote do:
let `x` = fromJS[`t`](ctx, `val`)
`x`.isOk
gen.addUnionParamBranch(query, quote do:
let `s` = `x`.get,
fallback)
# 10. If Type(V) is Object, then:
# Sequence:
if seqg.isSome:
let query = quote do:
isSequence(ctx, `val`)
let a = seqg.get[1]
gen.addUnionParamBranch(query, quote do:
let `s` = fromJS_or_die(seq[`a`], ctx, `val`, `ev`, `dl`),
fallback)
# Record:
if tableg.isSome:
let a = tableg.get[1]
let b = tableg.get[2]
let query = quote do:
JS_IsObject(`val`)
gen.addUnionParamBranch(query, quote do:
let `s` = fromJS_or_die(Table[`a`, `b`], ctx, `val`, `ev`, `dl`),
fallback)
# Object (JSObject variant):
#TODO non-JS objects (i.e. ref object)
if hasJSValue:
let query = quote do:
JS_IsObject(`val`)
gen.addUnionParamBranch(query, quote do:
let `s` = fromJS_or_die(JSValue, ctx, `val`, `ev`, `dl`),
fallback)
# 11. If Type(V) is Boolean, then:
if hasBoolean:
let query = quote do:
JS_IsBool(`val`)
gen.addUnionParamBranch(query, quote do:
let `s` = fromJS_or_die(bool, ctx, `val`, `ev`, `dl`),
fallback)
# 12. If Type(V) is Number, then:
if numg.isSome:
let ng = numg.get
let query = quote do:
JS_IsNumber(`val`)
gen.addUnionParamBranch(query, quote do:
let `s` = fromJS_or_die(`ng`, ctx, `val`, `ev`, `dl`),
fallback)
# 14. If types includes a string type, then return the result of converting V
# to that type.
if hasString:
gen.addParam2(s, string.getType(), quote do: `val`, fallback)
# 16. If types includes a numeric type, then return the result of converting
# V to that numeric type.
elif numg.isSome:
gen.addParam2(s, numg.get.getType(), quote do: `val`, fallback)
# 17. If types includes boolean, then return the result of converting V to
# boolean.
elif hasBoolean:
gen.addParam2(s, bool.getType(), quote do: `val`, fallback)
# 19. Throw a TypeError.
else:
gen.addParam2(s, string.getType(), quote do:
if true:
discard JS_ThrowTypeError(ctx, "No match for union type")
return `ev`
JS_NULL, fallback)
for branch in gen.newBranchList:
gen.jsFunCallLists.add(branch)
gen.newBranchList.setLen(0)
proc addUnionParam(gen: var JSFuncGenerator, tt: NimNode, s: NimNode,
fallback: NimNode = nil) =
let j = gen.j
gen.addUnionParam0(tt, s, quote do: argv[`j`], fallback)
proc addFixParam(gen: var JSFuncGenerator, name: string) =
let s = ident("arg_" & $gen.i)
let t = gen.funcParams[gen.i][1]
let id = ident(name)
if t.typeKind == ntyGenericParam:
gen.addUnionParam0(t, s, id)
else:
gen.addParam2(s, t, id)
if gen.jsFunCall != nil:
gen.jsFunCall.add(s)
inc gen.i
proc addRequiredParams(gen: var JSFuncGenerator) =
while gen.i < gen.minArgs:
let s = ident("arg_" & $gen.i)
let tt = gen.funcParams[gen.i][1]
if tt.typeKind == ntyGenericParam:
gen.addUnionParam(tt, s)
else:
gen.addValueParam(s, tt)
if gen.jsFunCall != nil:
gen.jsFunCall.add(s)
inc gen.j
inc gen.i
proc addOptionalParams(gen: var JSFuncGenerator) =
while gen.i < gen.funcParams.len:
let j = gen.j
let s = ident("arg_" & $gen.i)
let tt = gen.funcParams[gen.i][1]
if tt.typeKind == varargs.getType().typeKind: # pray it's not a generic...
let vt = tt[1].getType()
for i in 0..gen.jsFunCallLists.high:
gen.jsFunCallLists[i].add(newLetStmt(s, quote do:
(
var valist: seq[`vt`]
for i in `j`..<argc:
let it = fromJS_or_return(`vt`, ctx, argv[i])
valist.add(it)
valist
)
))
else:
if gen.funcParams[gen.i][2].isNone:
error("No fallback value. Maybe a non-optional parameter follows an " &
"optional parameter?")
let fallback = gen.funcParams[gen.i][2].get
if tt.typeKind == ntyGenericParam:
gen.addUnionParam(tt, s, fallback)
else:
gen.addValueParam(s, tt, fallback)
if gen.jsFunCall != nil:
gen.jsFunCall.add(s)
inc gen.j
inc gen.i
proc finishFunCallList(gen: var JSFuncGenerator) =
for branch in gen.jsFunCallLists:
branch.add(gen.jsFunCall)
var js_funcs {.compileTime.}: Table[string, JSFuncGenerator]
var existing_funcs {.compileTime.}: HashSet[string]
var js_dtors {.compileTime.}: HashSet[string]
proc newBoundFunction(t: BoundFunctionType, name: string, id: NimNode,
magic: uint16 = 0, uf = false, isstatic = false): BoundFunction =
return BoundFunction(
t: t,
name: name,
id: id,
magic: magic,
unforgeable: uf,
isstatic: isstatic
)
proc registerFunction(typ: string, nf: BoundFunction) =
BoundFunctions.withValue(typ, val):
val[].add(nf)
do:
BoundFunctions[typ] = @[nf]
existing_funcs.incl(nf.id.strVal)
proc registerFunction(typ: string, t: BoundFunctionType, name: string,
id: NimNode, magic: uint16 = 0, uf = false, isstatic = false) =
let nf = newBoundFunction(t, name, id, magic, uf, isstatic)
registerFunction(typ, nf)
proc registerConstructor(gen: JSFuncGenerator) =
registerFunction(gen.thisType, gen.t, gen.funcName, gen.newName,
uf = gen.unforgeable, isstatic = gen.isstatic)
js_funcs[gen.funcName] = gen
proc registerFunction(gen: JSFuncGenerator) =
registerFunction(gen.thisType, gen.t, gen.funcName, gen.newName,
uf = gen.unforgeable, isstatic = gen.isstatic)
export JS_ThrowTypeError, JS_ThrowRangeError, JS_ThrowSyntaxError,
JS_ThrowInternalError, JS_ThrowReferenceError
proc newJSProcBody(gen: var JSFuncGenerator, isva: bool): NimNode =
let tt = gen.thisType
let fn = gen.funcName
var ma = gen.actualMinArgs
result = newStmtList()
if isva:
result.add(quote do:
if argc < `ma`:
return JS_ThrowTypeError(ctx, "At least %d arguments required, " &
"but only %d passed", `ma`, argc)
)
if gen.thisname.isSome and not gen.isstatic:
let tn = ident(gen.thisname.get)
let ev = gen.errval
result.add(quote do:
if not ctx.isInstanceOf(`tn`, `tt`):
discard JS_ThrowTypeError(ctx,
"'%s' called on an object that is not an instance of %s", `fn`, `tt`)
return `ev`
)
result.add(gen.jsCallAndRet)
proc newJSProc(gen: var JSFuncGenerator, params: openArray[NimNode],
isva = true): NimNode =
let jsBody = gen.newJSProcBody(isva)
let jsPragmas = newNimNode(nnkPragma).add(ident("cdecl"))
gen.res = newProc(gen.newName, params, jsBody, pragmas = jsPragmas)
return gen.res
func getFuncName(fun: NimNode, jsname: string): string =
if jsname != "":
return jsname
let x = $fun[0]
if x == "$":
# stringifier
return "toString"
return x
func getErrVal(t: BoundFunctionType): NimNode =
if t in {PROPERTY_GET, PROPERTY_SET, PROPERTY_DEL, PROPERTY_HAS,
PROPERTY_NAMES}:
return quote do: cint(-1)
return quote do: JS_EXCEPTION
proc addJSContext(gen: var JSFuncGenerator) =
if gen.funcParams.len > gen.i:
if gen.funcParams[gen.i].t.eqIdent(ident("JSContext")):
gen.passCtx = true
gen.jsFunCall.add(ident("ctx"))
inc gen.i
elif gen.funcParams[gen.i].t.eqIdent(ident("JSRuntime")):
inc gen.i # special case for finalizers that have a JSRuntime param
proc addThisName(gen: var JSFuncGenerator, thisname: Option[string]) =
if thisname.isSome:
gen.thisTypeNode = gen.funcParams[gen.i][1]
gen.thisType = $gen.funcParams[gen.i][1]
gen.newName = ident($gen.t & "_" & gen.thisType & "_" & gen.funcName)
else:
let rt = gen.returnType.get
if rt.kind in {nnkRefTy, nnkPtrTy}:
gen.thisTypeNode = rt[0]
gen.thisType = rt[0].strVal
else:
if rt.kind == nnkBracketExpr:
gen.thisTypeNode = rt[1]
gen.thisType = rt[1].strVal
else:
gen.thisTypeNode = rt
gen.thisType = rt.strVal
gen.newName = ident($gen.t & "_" & gen.funcName)
func getActualMinArgs(gen: var JSFuncGenerator): int =
var ma = gen.minArgs
if gen.thisname.isSome and not gen.isstatic:
dec ma
if gen.passCtx:
dec ma
assert ma >= 0
return ma
proc setupGenerator(fun: NimNode, t: BoundFunctionType,
thisname = some("this"), jsname: string = "", unforgeable = false,
isstatic = false, thisType = ""): JSFuncGenerator =
let jsFunCallList = newStmtList()
let funcParams = getParams(fun)
var gen = JSFuncGenerator(
t: t,
funcName: getFuncName(fun, jsname),
generics: getGenerics(fun),
funcParams: funcParams,
returnType: getReturn(fun),
minArgs: funcParams.getMinArgs(),
thisname: thisname,
errval: getErrVal(t),
dielabel: ident("ondie"),
jsFunCallList: jsFunCallList,
jsFunCallLists: @[jsFunCallList],
jsFunCall: newCall(fun[0]),
unforgeable: unforgeable,
isstatic: isstatic
)
gen.addJSContext()
gen.actualMinArgs = gen.getActualMinArgs() # must come after passctx is set
if thisType == "":
gen.addThisName(thisname)
else:
gen.thisType = thisType
gen.newName = ident($gen.t & "_" & gen.funcName)
return gen
proc makeJSCallAndRet(gen: var JSFuncGenerator, okstmt, errstmt: NimNode) =
let jfcl = gen.jsFunCallList
let dl = gen.dielabel
gen.jsCallAndRet = if gen.returnType.isSome:
quote do:
block `dl`:
return ctx.toJS(`jfcl`)
`errstmt`
else:
quote do:
block `dl`:
`jfcl`
`okstmt`
`errstmt`
proc makeCtorJSCallAndRet(gen: var JSFuncGenerator, errstmt: NimNode) =
let jfcl = gen.jsFunCallList
let dl = gen.dielabel
gen.jsCallAndRet = quote do:
block `dl`:
return ctx.toJSNew(`jfcl`, this)
`errstmt`
macro jsctor*(fun: typed) =
var gen = setupGenerator(fun, CONSTRUCTOR, thisname = none(string))
if gen.newName.strVal in existing_funcs:
#TODO TODO TODO implement function overloading
error("Function overloading hasn't been implemented yet...")
gen.addRequiredParams()
gen.addOptionalParams()
gen.finishFunCallList()
let errstmt = quote do:
return JS_ThrowTypeError(ctx, "Invalid parameters passed to constructor")
gen.makeCtorJSCallAndRet(errstmt)
discard gen.newJSProc(getJSParams())
gen.registerConstructor()
return newStmtList(fun)
macro jshasprop*(fun: typed) =
var gen = setupGenerator(fun, PROPERTY_HAS, thisname = some("obj"))
if gen.newName.strVal in existing_funcs:
#TODO TODO TODO ditto
error("Function overloading hasn't been implemented yet...")
gen.addFixParam("obj")
gen.addFixParam("atom")
gen.finishFunCallList()
let jfcl = gen.jsFunCallList
let dl = gen.dielabel
gen.jsCallAndRet = quote do:
block `dl`:
let retv = `jfcl`
return cint(retv)
doAssert false # TODO?
let jsProc = gen.newJSProc(getJSHasPropParams(), false)
gen.registerFunction()
return newStmtList(fun, jsProc)
macro jsgetprop*(fun: typed) =
var gen = setupGenerator(fun, PROPERTY_GET, thisname = some("obj"))
if gen.newName.strVal in existing_funcs:
#TODO TODO TODO ditto
error("Function overloading hasn't been implemented yet...")
gen.addFixParam("obj")
gen.addFixParam("prop")
gen.finishFunCallList()
let jfcl = gen.jsFunCallList
let dl = gen.dielabel
gen.jsCallAndRet = quote do:
block `dl`:
let retv = ctx.toJS(`jfcl`)
if retv != JS_NULL:
if desc != nil:
# From quickjs.h:
# > If 1 is returned, the property descriptor 'desc' is filled
# > if != NULL.
# So desc may be nil.
desc[].setter = JS_UNDEFINED
desc[].getter = JS_UNDEFINED
desc[].value = retv
desc[].flags = 0
return cint(1)
return cint(0)
let jsProc = gen.newJSProc(getJSGetPropParams(), false)
gen.registerFunction()
return newStmtList(fun, jsProc)
macro jssetprop*(fun: typed) =
var gen = setupGenerator(fun, PROPERTY_SET, thisname = some("obj"))
if gen.newName.strVal in existing_funcs:
#TODO TODO TODO ditto
error("Function overloading hasn't been implemented yet...")
gen.addFixParam("receiver")
gen.addFixParam("atom")
gen.addFixParam("value")
gen.finishFunCallList()
let jfcl = gen.jsFunCallList
let dl = gen.dielabel
gen.jsCallAndRet = if gen.returnType.isSome:
quote do:
block `dl`:
let v = toJS(ctx, `jfcl`)
if not JS_IsException(v):
return cint(1)
return cint(-1)
else:
quote do:
block `dl`:
`jfcl`
return cint(1)
return cint(-1)
let jsProc = gen.newJSProc(getJSSetPropParams(), false)
gen.registerFunction()
return newStmtList(fun, jsProc)
macro jsdelprop*(fun: typed) =
var gen = setupGenerator(fun, PROPERTY_DEL, thisname = some("obj"))
if gen.newName.strVal in existing_funcs:
#TODO TODO TODO ditto
error("Function overloading hasn't been implemented yet...")
gen.addFixParam("obj")
gen.addFixParam("prop")
gen.finishFunCallList()
let jfcl = gen.jsFunCallList
let dl = gen.dielabel
gen.jsCallAndRet = quote do:
block `dl`:
let retv = `jfcl`
return cint(retv)
return cint(-1)
let jsProc = gen.newJSProc(getJSDelPropParams(), false)
gen.registerFunction()
return newStmtList(fun, jsProc)
macro jspropnames*(fun: typed) =
var gen = setupGenerator(fun, PROPERTY_NAMES, thisname = some("obj"))
if gen.newName.strVal in existing_funcs:
#TODO TODO TODO ditto
error("Function overloading hasn't been implemented yet...")
gen.addFixParam("obj")
gen.finishFunCallList()
let jfcl = gen.jsFunCallList
let dl = gen.dielabel
gen.jsCallAndRet = quote do:
block `dl`:
let retv = `jfcl`
ptab[] = retv.buffer
plen[] = retv.len
return cint(0)
return cint(-1)
let jsProc = gen.newJSProc(getJSPropNamesParams(), false)
gen.registerFunction()
return newStmtList(fun, jsProc)
macro jsfgetn(jsname: static string, uf: static bool, fun: typed) =
var gen = setupGenerator(fun, GETTER, jsname = jsname, unforgeable = uf)
if gen.actualMinArgs != 0 or gen.funcParams.len != gen.minArgs:
error("jsfget functions must only accept one parameter.")
if gen.returnType.isNone:
error("jsfget functions must have a return type.")
if gen.newName.strVal in existing_funcs:
#TODO TODO TODO ditto
error("Function overloading hasn't been implemented yet...")
gen.addFixParam("this")
gen.finishFunCallList()
gen.makeJSCallAndRet(nil, quote do: discard)
let jsProc = gen.newJSProc(getJSGetterParams(), false)
gen.registerFunction()
return newStmtList(fun, jsProc)
# "Why?" So the compiler doesn't cry.
template jsfget*(fun: typed) =
jsfgetn("", false, fun)
template jsuffget*(fun: typed) =
jsfgetn("", true, fun)
template jsfget*(jsname: static string, fun: typed) =
jsfgetn(jsname, false, fun)
template jsuffget*(jsname: static string, fun: typed) =
jsfgetn(jsname, true, fun)
# Ideally we could simulate JS setters using nim setters, but nim setters
# won't accept types that don't match their reflected field's type.
macro jsfsetn(jsname: static string, fun: typed) =
var gen = setupGenerator(fun, SETTER, jsname = jsname)
if gen.actualMinArgs != 1 or gen.funcParams.len != gen.minArgs:
error("jsfset functions must accept two parameters")
if gen.returnType.isSome:
let rt = gen.returnType.get
#TODO ??
let rtType = rt[0]
let errType = getTypeInst(Err)
if not errType.sameType(rtType) and not rtType.sameType(errType):
error("jsfset functions must not have a return type")
gen.addFixParam("this")
gen.addFixParam("val")
gen.finishFunCallList()
# return param anyway
let okstmt = quote do: discard
let errstmt = quote do: return JS_DupValue(ctx, val)
gen.makeJSCallAndRet(okstmt, errstmt)
let jsProc = gen.newJSProc(getJSSetterParams(), false)
gen.registerFunction()
return newStmtList(fun, jsProc)
template jsfset*(fun: typed) =
jsfsetn("", fun)
template jsfset*(jsname: static string, fun: typed) =
jsfsetn(jsname, fun)
macro jsfuncn*(jsname: static string, uf: static bool,
staticname: static string, fun: typed) =
var gen = setupGenerator(fun, FUNCTION, jsname = jsname, unforgeable = uf,
isstatic = staticname != "", thisType = staticname)
if gen.minArgs == 0 and not gen.isstatic:
error("Zero-parameter functions are not supported. (Maybe pass Window or Client?)")
if not gen.isstatic:
gen.addFixParam("this")
gen.addRequiredParams()
gen.addOptionalParams()
gen.finishFunCallList()
let okstmt = quote do:
return JS_UNDEFINED
let errstmt = quote do:
return JS_ThrowTypeError(ctx, "Invalid parameters passed to function")
gen.makeJSCallAndRet(okstmt, errstmt)
let jsProc = gen.newJSProc(getJSParams())
gen.registerFunction()
return newStmtList(fun, jsProc)
template jsfunc*(fun: typed) =
jsfuncn("", false, "", fun)
template jsuffunc*(fun: typed) =
jsfuncn("", true, "", fun)
template jsfunc*(jsname: static string, fun: typed) =
jsfuncn(jsname, false, "", fun)
template jsuffunc*(jsname: static string, fun: typed) =
jsfuncn(jsname, true, "", fun)
template jsstfunc*(name: static string, fun: typed) =
jsfuncn("", false, name, fun)
macro jsfin*(fun: typed) =
var gen = setupGenerator(fun, FINALIZER, thisname = some("fin"))
let finName = gen.newName
let finFun = ident(gen.funcName)
let t = gen.thisTypeNode
if gen.minArgs == 1:
let jsProc = quote do:
proc `finName`(rt: JSRuntime, val: JSValue) =
let opaque = JS_GetOpaque(val, JS_GetClassID(val))
if opaque != nil:
`finFun`(cast[`t`](opaque))
gen.registerFunction()
result = newStmtList(fun, jsProc)
elif gen.minArgs == 2:
let jsProc = quote do:
proc `finName`(rt: JSRuntime, val: JSValue) =
let opaque = JS_GetOpaque(val, JS_GetClassID(val))
if opaque != nil:
`finFun`(rt, cast[`t`](opaque))
gen.registerFunction()
result = newStmtList(fun, jsProc)
else:
error("Expected one or two parameters")
# Having the same names for these and the macros leads to weird bugs, so the
# macros get an additional f.
template jsget*() {.pragma.}
template jsget*(name: string) {.pragma.}
template jsset*() {.pragma.}
template jsset*(name: string) {.pragma.}
template jsgetset*() {.pragma.}
template jsgetset*(name: string) {.pragma.}
template jsufget*() {.pragma.}
template jsufget*(name: string) {.pragma.}
proc js_illegal_ctor*(ctx: JSContext, this: JSValue, argc: cint,
argv: ptr UncheckedArray[JSValue]): JSValue {.cdecl.} =
return JS_ThrowTypeError(ctx, "Illegal constructor")
type
JSObjectPragma = object
name: string
varsym: NimNode
unforgeable: bool
JSObjectPragmas = object
jsget: seq[JSObjectPragma]
jsset: seq[JSObjectPragma]
jsinclude: seq[JSObjectPragma]
func getPragmaName(varPragma: NimNode): string =
if varPragma.kind == nnkExprColonExpr:
return $varPragma[0]
return $varPragma
func getStringFromPragma(varPragma: NimNode): Option[string] =
if varPragma.kind == nnkExprColonExpr:
if not varPragma.len == 1 and varPragma[1].kind == nnkStrLit:
error("Expected string as pragma argument")
return some($varPragma[1])
proc findPragmas(t: NimNode): JSObjectPragmas =
let typ = t.getTypeInst()[1] # The type, as declared.
var impl = typ.getTypeImpl() # ref t
if impl.kind in {nnkRefTy, nnkPtrTy}:
impl = impl[0].getImpl()
else:
impl = typ.getImpl()
# stolen from std's macros.customPragmaNode
var identDefsStack = newSeq[NimNode](impl[2].len)
for i in 0 ..< identDefsStack.len:
identDefsStack[i] = impl[2][i]
var pragmas: JSObjectPragmas
while identDefsStack.len > 0:
var identDefs = identDefsStack.pop()
case identDefs.kind
of nnkRecList:
for child in identDefs.children:
identDefsStack.add(child)
of nnkRecCase:
# Add condition definition
identDefsStack.add(identDefs[0])
# Add branches
for i in 1 ..< identDefs.len:
identDefsStack.add(identDefs[i].last)
else:
for i in 0 .. identDefs.len - 3:
let varNode = identDefs[i]
if varNode.kind == nnkPragmaExpr:
var varName = varNode[0]
if varName.kind == nnkPostfix:
# This is a public field. We are skipping the postfix *
varName = varName[1]
var varPragmas = varNode[1]
for varPragma in varPragmas:
let pragmaName = getPragmaName(varPragma)
var op = JSObjectPragma(
name: getStringFromPragma(varPragma).get($varName),
varsym: varName
)
case pragmaName
of "jsget": pragmas.jsget.add(op)
of "jsset": pragmas.jsset.add(op)
of "jsufget": # LegacyUnforgeable
op.unforgeable = true
pragmas.jsget.add(op)
of "jsgetset":
pragmas.jsget.add(op)
pragmas.jsset.add(op)
of "jsinclude": pragmas.jsinclude.add(op)
return pragmas
proc nim_finalize_for_js*(obj: pointer) =
for rt in runtimes:
let rtOpaque = rt.getOpaque()
rtOpaque.plist.withValue(obj, v):
let p = v[]
let val = JS_MKPTR(JS_TAG_OBJECT, p)
let classid = JS_GetClassID(val)
rtOpaque.fins.withValue(classid, fin):
fin[](rt, val)
JS_SetOpaque(val, nil)
rtOpaque.plist.del(obj)
if rtOpaque.destroying == obj:
# Allow QJS to collect the JSValue through checkDestroy.
rtOpaque.destroying = nil
else:
JS_FreeValueRT(rt, val)
type
TabGetSet* = object
name*: string
get*: JSGetterMagicFunction
set*: JSSetterMagicFunction
magic*: int16
TabFunc* = object
name*: string
fun*: JSCFunction
template jsDestructor*[U](T: typedesc[ref U]) =
static:
js_dtors.incl($T)
when NimMajor >= 2:
proc `=destroy`(obj: U) =
nim_finalize_for_js(addr obj)
else:
proc `=destroy`(obj: var U) =
nim_finalize_for_js(addr obj)
template jsDestructor*(T: typedesc[object]) =
static:
js_dtors.incl($T)
when NimMajor >= 2:
proc `=destroy`(obj: T) =
nim_finalize_for_js(addr obj)
else:
proc `=destroy`(obj: var T) =
nim_finalize_for_js(addr obj)
type RegistryInfo = object
t: NimNode # NimNode of type
name: string # JS name, if this is the empty string then it equals tname
tabList: NimNode # array of function table
ctorImpl: NimNode # definition & body of constructor
ctorFun: NimNode # constructor ident
getset: Table[string, (NimNode, NimNode, bool)] # name -> get, set, uf
propGetFun: NimNode # custom get function ident
propSetFun: NimNode # custom set function ident
propDelFun: NimNode # custom del function ident
propHasFun: NimNode # custom has function ident
propNamesFun: NimNode # custom property names function ident
finFun: NimNode # finalizer ident
finName: NimNode # finalizer wrapper ident
dfin: NimNode # CheckDestroy finalizer ident
classDef: NimNode # ClassDef ident
tabUnforgeable: NimNode # array of unforgeable function table
tabStatic: NimNode # array of static function table
func tname(info: RegistryInfo): string =
return info.t.strVal
# Differs from tname if the Nim object's name differs from the JS object's
# name.
func jsname(info: RegistryInfo): string =
if info.name != "":
return info.name
return info.tname
proc newRegistryInfo(t: NimNode, name: string): RegistryInfo =
let info = RegistryInfo(
t: t,
name: name,
dfin: ident("js_" & t.strVal & "ClassCheckDestroy"),
classDef: ident("classDef"),
tabList: newNimNode(nnkBracket),
tabUnforgeable: newNimNode(nnkBracket),
tabStatic: newNimNode(nnkBracket),
finName: newNilLit(),
finFun: newNilLit(),
propGetFun: newNilLit(),
propSetFun: newNilLit(),
propDelFun: newNilLit(),
propHasFun: newNilLit(),
propNamesFun: newNilLit()
)
if info.tname notin js_dtors:
warning("No destructor has been defined for type " & info.tname)
return info
proc bindConstructor(stmts: NimNode, info: var RegistryInfo): NimNode =
if info.ctorFun != nil:
stmts.add(info.ctorImpl)
return info.ctorFun
return ident("js_illegal_ctor")
proc registerGetters(stmts: NimNode, info: RegistryInfo,
jsget: seq[JSObjectPragma]) =
let t = info.t
let tname = info.tname
let jsname = info.jsname
for op in jsget:
let node = op.varsym
let fn = op.name
let id = ident($GETTER & "_" & tname & "_" & fn)
stmts.add(quote do:
proc `id`(ctx: JSContext, this: JSValue): JSValue {.cdecl.} =
if not ctx.isInstanceOf(this, `tname`):
return JS_ThrowTypeError(ctx,
"'%s' called on an object that is not an instance of %s", `fn`,
`jsname`)
let arg_0 = fromJSP_or_return(`t`, ctx, this)
when typeof(arg_0.`node`) is object:
return toJSP(ctx, arg_0, arg_0.`node`)
else:
return toJS(ctx, arg_0.`node`)
)
let nf = newBoundFunction(GETTER, fn, id, uf = op.unforgeable)
registerFunction(tname, nf)
proc registerSetters(stmts: NimNode, info: RegistryInfo,
jsset: seq[JSObjectPragma]) =
let t = info.t
let tname = info.tname
let jsname = info.jsname
for op in jsset:
let node = op.varsym
let fn = op.name
let id = ident($SETTER & "_" & tname & "_" & fn)
stmts.add(quote do:
proc `id`(ctx: JSContext, this: JSValue, val: JSValue): JSValue
{.cdecl.} =
if not ctx.isInstanceOf(this, `tname`):
return JS_ThrowTypeError(ctx,
"'%s' called on an object that is not an instance of %s", `fn`,
`jsname`)
let arg_0 = fromJSP_or_return(`t`, ctx, this)
let arg_1 = val
# Note: if you get a compiler error that leads back to here, that
# might be because you added jsset to a non-ref object type.
arg_0.`node` = fromJS_or_return(typeof(arg_0.`node`), ctx, arg_1)
return JS_DupValue(ctx, arg_1)
)
registerFunction(tname, SETTER, fn, id)
proc bindFunctions(stmts: NimNode, info: var RegistryInfo) =
BoundFunctions.withValue(info.tname, funs):
for fun in funs[].mitems:
var f0 = fun.name
let f1 = fun.id
if fun.name.endsWith("_exceptions"):
fun.name = fun.name.substr(0, fun.name.high - "_exceptions".len)
case fun.t
of FUNCTION:
f0 = fun.name
if fun.unforgeable:
info.tabUnforgeable.add(quote do:
JS_CFUNC_DEF_NOCONF(`f0`, 0, cast[JSCFunction](`f1`)))
elif fun.isstatic:
info.tabStatic.add(quote do:
JS_CFUNC_DEF(`f0`, 0, cast[JSCFunction](`f1`)))
else:
info.tabList.add(quote do:
JS_CFUNC_DEF(`f0`, 0, cast[JSCFunction](`f1`)))
of CONSTRUCTOR:
info.ctorImpl = js_funcs[$f0].res
if info.ctorFun != nil:
error("Class " & info.tname & " has 2+ constructors.")
info.ctorFun = f1
of GETTER:
info.getset.withValue(f0, exv):
exv[0] = f1
exv[2] = fun.unforgeable
do:
info.getset[f0] = (f1, newNilLit(), fun.unforgeable)
of SETTER:
info.getset.withValue(f0, exv):
exv[1] = f1
do:
info.getset[f0] = (newNilLit(), f1, false)
of PROPERTY_GET:
if info.propGetFun.kind != nnkNilLit:
error("Class " & info.tname & " has 2+ property getters.")
info.propGetFun = f1
of PROPERTY_SET:
if info.propSetFun.kind != nnkNilLit:
error("Class " & info.tname & " has 2+ property setters.")
info.propSetFun = f1
of PROPERTY_DEL:
if info.propDelFun.kind != nnkNilLit:
error("Class " & info.tname & " has 2+ property setters.")
info.propDelFun = f1
of PROPERTY_HAS:
if info.propHasFun.kind != nnkNilLit:
error("Class " & info.tname & " has 2+ hasprop getters.")
info.propHasFun = f1
of PROPERTY_NAMES:
if info.propNamesFun.kind != nnkNilLit:
error("Class " & info.tname & " has 2+ propnames getters.")
info.propNamesFun = f1
of FINALIZER:
f0 = fun.name
info.finFun = ident(f0)
info.finName = f1
proc bindGetSet(stmts: NimNode, info: RegistryInfo) =
for k, (get, set, unforgeable) in info.getset:
if not unforgeable:
info.tabList.add(quote do: JS_CGETSET_DEF(`k`, `get`, `set`))
else:
info.tabUnforgeable.add(quote do:
JS_CGETSET_DEF_NOCONF(`k`, `get`, `set`))
proc bindExtraGetSet(stmts: NimNode, info: var RegistryInfo,
extra_getset: openArray[TabGetSet]) =
for x in extra_getset:
let k = x.name
let g = x.get
let s = x.set
let m = x.magic
info.tabList.add(quote do: JS_CGETSET_MAGIC_DEF(`k`, `g`, `s`, `m`))
proc bindCheckDestroy(stmts: NimNode, info: RegistryInfo) =
let t = info.t
let dfin = info.dfin
stmts.add(quote do:
proc `dfin`(rt: JSRuntime, val: JSValue): JS_BOOL {.cdecl.} =
let opaque = JS_GetOpaque(val, JS_GetClassID(val))
if opaque != nil:
when `t` is ref object:
# Before this function is called, the ownership model is
# JSObject -> Nim object.
# Here we change it to Nim object -> JSObject.
# As a result, Nim object's reference count can now reach zero (it is
# no longer "referenced" by the JS object).
# nim_finalize_for_js will be invoked by the Nim GC when the Nim
# refcount reaches zero. Then, the JS object's opaque will be set
# to nil, and its refcount decreased again, so next time this
# function will return true.
#
# Actually, we need another hack to ensure correct
# operation. GC_unref may call the destructor of this object, and
# in this case we cannot ask QJS to keep the JSValue alive. So we set
# the "destroying" pointer to the current opaque, and return true if
# the opaque was collected.
rt.getOpaque().destroying = opaque
GC_unref(cast[`t`](opaque))
if rt.getOpaque().destroying == nil:
# Looks like GC_unref called nim_finalize_for_js for this pointer.
# This means we can allow QJS to collect this JSValue.
return true
else:
rt.getOpaque().destroying = nil
# Returning false from this function signals to the QJS GC that it
# should not be collected yet. Accordingly, the JSObject's refcount
# will be set to one again.
return false
else:
# This is not a reference, just a pointer with a reference to the
# root ancestor object.
# Remove the reference, allowing destruction of the root object once
# again.
let rtOpaque = rt.getOpaque()
var crefunref: tuple[cref, cunref: (proc())]
discard rtOpaque.refmap.pop(opaque, crefunref)
crefunref.cunref()
# Of course, nim_finalize_for_js might only be called later for
# this object, because the parent can still have references to it.
# (And for the same reason, a reference to the same object might
# still be necessary.)
# Accordingly, we return false here as well.
return false
return true
)
proc bindEndStmts(endstmts: NimNode, info: RegistryInfo) =
let jsname = info.jsname
let dfin = info.dfin
let classDef = info.classDef
if info.propGetFun.kind != nnkNilLit or
info.propSetFun.kind != nnkNilLit or
info.propDelFun.kind != nnkNilLit or
info.propHasFun.kind != nnkNilLit or
info.propNamesFun.kind != nnkNilLit:
let propGetFun = info.propGetFun
let propSetFun = info.propSetFun
let propDelFun = info.propDelFun
let propHasFun = info.propHasFun
let propNamesFun = info.propNamesFun
endstmts.add(quote do:
var exotic {.global.} = JSClassExoticMethods(
get_own_property: `propGetFun`,
get_own_property_names: `propNamesFun`,
has_property: `propHasFun`,
set_property: `propSetFun`,
delete_property: `propDelFun`
)
var cd {.global.} = JSClassDef(
class_name: `jsname`,
can_destroy: `dfin`,
exotic: addr exotic
)
let `classDef` = JSClassDefConst(addr cd)
)
else:
endstmts.add(quote do:
var cd {.global.} = JSClassDef(
class_name: `jsname`,
can_destroy: `dfin`
)
let `classDef` = JSClassDefConst(addr cd))
macro registerType*(ctx: typed, t: typed, parent: JSClassID = 0,
asglobal = false, nointerface = false, name: static string = "",
has_extra_getset: static bool = false,
extra_getset: static openarray[TabGetSet] = [],
namespace: JSValue = JS_NULL, errid = opt(JSErrorEnum),
ishtmldda = false): JSClassID =
var stmts = newStmtList()
var info = newRegistryInfo(t, name)
let pragmas = findPragmas(t)
stmts.registerGetters(info, pragmas.jsget)
stmts.registerSetters(info, pragmas.jsset)
stmts.bindFunctions(info)
stmts.bindGetSet(info)
if has_extra_getset:
#HACK: for some reason, extra_getset gets weird contents when nothing is
# passed to it. So we need an extra flag to signal if anything has
# been passed to it at all.
stmts.bindExtraGetSet(info, extra_getset)
let sctr = stmts.bindConstructor(info)
stmts.bindCheckDestroy(info)
let endstmts = newStmtList()
endstmts.bindEndStmts(info)
let tabList = info.tabList
let finName = info.finName
let classDef = info.classDef
let tname = info.tname
let unforgeable = info.tabUnforgeable
let staticfuns = info.tabStatic
endstmts.add(quote do:
`ctx`.newJSClass(`classDef`, `tname`, getTypePtr(`t`), `sctr`, `tabList`,
`parent`, `asglobal`, `nointerface`, `finName`, `namespace`, `errid`,
`unforgeable`, `staticfuns`, `ishtmldda`)
)
stmts.add(newBlockStmt(endstmts))
return stmts
proc getMemoryUsage*(rt: JSRuntime): string =
var m: JSMemoryUsage
JS_ComputeMemoryUsage(rt, addr m)
return fmt"""
memory allocated: {m.malloc_count} {m.malloc_size} ({float(m.malloc_size)/float(m.malloc_count):.1f}/block)
memory used: {m.memory_used_count} {m.memory_used_size} ({float(m.malloc_size-m.memory_used_size)/float(m.memory_used_count):.1f} average slack)
atoms: {m.atom_count} {m.atom_size} ({float(m.atom_size)/float(m.atom_count):.1f}/atom)
strings: {m.str_count} {m.str_size} ({float(m.str_size)/float(m.str_count):.1f}/string)
objects: {m.obj_count} {m.obj_size} ({float(m.obj_size)/float(m.obj_count):.1f}/object)
properties: {m.prop_count} {m.prop_size} ({float(m.prop_size)/float(m.obj_count):.1f}/object)
shapes: {m.shape_count} {m.shape_size} ({float(m.shape_size)/float(m.shape_count):.1f}/shape)
js functions: {m.js_func_count} {m.js_func_size} ({float(m.js_func_size)/float(m.js_func_count):.1f}/function)
native functions: {m.c_func_count}
arrays: {m.array_count}
fast arrays: {m.fast_array_count}
fast array elements: {m.fast_array_elements} {m.fast_array_elements*sizeof(JSValue)} ({float(m.fast_array_elements)/float(m.fast_array_count):.1f})
binary objects: {m.binary_object_count} {m.binary_object_size}"""
proc eval*(ctx: JSContext, s: string, file: string, eval_flags: int): JSValue =
return JS_Eval(ctx, cstring(s), csize_t(s.len), cstring(file),
cint(eval_flags))
proc compileScript*(ctx: JSContext, s: string, file: cstring): JSValue =
return JS_Eval(ctx, cstring(s), csize_t(s.len), file,
cint(JS_EVAL_FLAG_COMPILE_ONLY))
proc compileModule*(ctx: JSContext, s: string, file: cstring): JSValue =
return JS_Eval(ctx, cstring(s), csize_t(s.len), file,
cint(JS_EVAL_TYPE_MODULE or JS_EVAL_FLAG_COMPILE_ONLY))
proc evalFunction*(ctx: JSContext, val: JSValue): JSValue =
return JS_EvalFunction(ctx, val)
|