This repository was archived by the owner on Jun 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 38
Expand file tree
/
Copy pathreactjs_jsx_ppx_v3.ml
More file actions
906 lines (852 loc) · 43.8 KB
/
reactjs_jsx_ppx_v3.ml
File metadata and controls
906 lines (852 loc) · 43.8 KB
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
open Ast_helper
open Ast_mapper
open Asttypes
open Parsetree
open Longident
let rec find_opt p = function [] -> None | x :: l -> if p x then Some x else find_opt p l
let nolabel = Nolabel
let labelled str = Labelled str
let isOptional str = match str with Optional _ -> true | _ -> false
let isLabelled str = match str with Labelled _ -> true | _ -> false
let isForwardRef = function
| { pexp_desc = Pexp_ident { txt = (Ldot (Lident "React", "forwardRef")) } } -> true
| _ -> false
let getLabel str = match str with Optional str | Labelled str -> str | Nolabel -> ""
let optionIdent = Lident "option"
let optionalAttr = [ ({ txt = "optional"; loc = Location.none }, PStr []) ]
let constantString ~loc str = Ast_helper.Exp.constant ~loc (Pconst_string (str, None))
let recordWithOnlyKey ~loc = Exp.record ~loc
(* {key: @optional None} *)
[({loc; txt = Lident "key"}, Exp.construct ~attrs:optionalAttr {loc; txt = Lident "None"} None)]
None
let safeTypeFromValue valueStr =
let valueStr = getLabel valueStr in
match String.sub valueStr 0 1 with "_" -> "T" ^ valueStr | _ -> valueStr
[@@raises Invalid_argument]
let keyType loc = Typ.constr ~loc { loc; txt = Lident "string" } []
let refType loc = (Typ.constr ~loc { loc; txt = Ldot (Ldot (Lident "ReactDOM", "Ref"), "currentDomRef") } [])
type 'a children = ListLiteral of 'a | Exact of 'a
(* if children is a list, convert it to an array while mapping each element. If not, just map over it, as usual *)
let transformChildrenIfListUpper ~loc ~mapper theList =
let rec transformChildren_ theList accum =
(* not in the sense of converting a list to an array; convert the AST
reprensentation of a list to the AST reprensentation of an array *)
match theList with
| { pexp_desc = Pexp_construct ({ txt = Lident "[]" }, None) } -> (
match accum with
| [ singleElement ] -> Exact singleElement
| accum -> ListLiteral (Exp.array ~loc (List.rev accum)) )
| { pexp_desc = Pexp_construct ({ txt = Lident "::" }, Some { pexp_desc = Pexp_tuple [ v; acc ] }) } ->
transformChildren_ acc (mapper.expr mapper v :: accum)
| notAList -> Exact (mapper.expr mapper notAList)
in
transformChildren_ theList []
let transformChildrenIfList ~loc ~mapper theList =
let rec transformChildren_ theList accum =
(* not in the sense of converting a list to an array; convert the AST
reprensentation of a list to the AST reprensentation of an array *)
match theList with
| { pexp_desc = Pexp_construct ({ txt = Lident "[]" }, None) } -> Exp.array ~loc (List.rev accum)
| { pexp_desc = Pexp_construct ({ txt = Lident "::" }, Some { pexp_desc = Pexp_tuple [ v; acc ] }) } ->
transformChildren_ acc (mapper.expr mapper v :: accum)
| notAList -> mapper.expr mapper notAList
in
transformChildren_ theList []
let extractChildren ?(removeLastPositionUnit = false) ~loc propsAndChildren =
let rec allButLast_ lst acc =
match lst with
| [] -> []
| [ (Nolabel, { pexp_desc = Pexp_construct ({ txt = Lident "()" }, None) }) ] -> acc
| (Nolabel, _) :: _rest -> raise (Invalid_argument "JSX: found non-labelled argument before the last position")
| arg :: rest -> allButLast_ rest (arg :: acc)
[@@raises Invalid_argument]
in
let allButLast lst = allButLast_ lst [] |> List.rev [@@raises Invalid_argument] in
match List.partition (fun (label, _) -> label = labelled "children") propsAndChildren with
| [], props ->
(* no children provided? Place a placeholder list *)
(Exp.construct ~loc { loc; txt = Lident "[]" } None, if removeLastPositionUnit then allButLast props else props)
| [ (_, childrenExpr) ], props -> (childrenExpr, if removeLastPositionUnit then allButLast props else props)
| _ -> raise (Invalid_argument "JSX: somehow there's more than one `children` label")
[@@raises Invalid_argument]
let unerasableIgnore loc = ({ loc; txt = "warning" }, PStr [ Str.eval (Exp.constant (Pconst_string ("-16", None))) ])
let merlinFocus = ({ loc = Location.none; txt = "merlin.focus" }, PStr [])
(* Helper method to look up the [@react.component] attribute *)
let hasAttr (loc, _) = loc.txt = "react.component"
(* Helper method to filter out any attribute that isn't [@react.component] *)
let otherAttrsPure (loc, _) = loc.txt <> "react.component"
(* Iterate over the attributes and try to find the [@react.component] attribute *)
let hasAttrOnBinding { pvb_attributes } = find_opt hasAttr pvb_attributes <> None
(* Finds the name of the variable the binding is assigned to, otherwise raises Invalid_argument *)
let rec getFnName binding =
match binding with
| { ppat_desc = Ppat_var { txt } } -> txt
| { ppat_desc = Ppat_constraint (pat, _) } -> getFnName pat
| _ -> raise (Invalid_argument "react.component calls cannot be destructured.")
[@@raises Invalid_argument]
let makeNewBinding binding expression newName =
match binding with
| { pvb_pat = { ppat_desc = Ppat_var ppat_var } as pvb_pat } ->
{
binding with
pvb_pat = { pvb_pat with ppat_desc = Ppat_var { ppat_var with txt = newName } };
pvb_expr = expression;
pvb_attributes = [ merlinFocus ];
}
| _ -> raise (Invalid_argument "react.component calls cannot be destructured.")
[@@raises Invalid_argument]
(* Lookup the filename from the location information on the AST node and turn it into a valid module identifier *)
let filenameFromLoc (pstr_loc : Location.t) =
let fileName = match pstr_loc.loc_start.pos_fname with "" -> !Location.input_name | fileName -> fileName in
let fileName = try Filename.chop_extension (Filename.basename fileName) with Invalid_argument _ -> fileName in
let fileName = String.capitalize_ascii fileName in
fileName
(* Build a string representation of a module name with segments separated by $ *)
let makeModuleName fileName nestedModules fnName =
let fullModuleName =
match (fileName, nestedModules, fnName) with
(* TODO: is this even reachable? It seems like the fileName always exists *)
| "", nestedModules, "make" -> nestedModules
| "", nestedModules, fnName -> List.rev (fnName :: nestedModules)
| fileName, nestedModules, "make" -> fileName :: List.rev nestedModules
| fileName, nestedModules, fnName -> fileName :: List.rev (fnName :: nestedModules)
in
let fullModuleName = String.concat "$" fullModuleName in
fullModuleName
(*
AST node builders
These functions help us build AST nodes that are needed when transforming a [@react.component] into a
constructor and a props external
*)
(* make record from props and spread props if exists *)
let recordFromProps { pexp_loc } callArguments =
let rec removeLastPositionUnitAux props acc =
match props with
| [] -> acc
| [ (Nolabel, { pexp_desc = Pexp_construct ({ txt = Lident "()" }, None) }) ] -> acc
| (Nolabel, _) :: _rest -> raise (Invalid_argument "JSX: found non-labelled argument before the last position")
| prop :: rest -> removeLastPositionUnitAux rest (prop :: acc)
in
let props, propsToSpread = removeLastPositionUnitAux callArguments []
|> List.rev
|> List.partition (fun (label, _) -> label <> labelled "spreadProps") in
let fields = props |> List.map (fun (arg_label, ({ pexp_loc } as expr) ) ->
(* In case filed label is "key" only then change expression to option *)
if isOptional arg_label then
({ txt = (Lident (getLabel arg_label)); loc = pexp_loc} , { expr with pexp_attributes = optionalAttr })
else
({ txt = (Lident (getLabel arg_label)); loc = pexp_loc} , expr))
in
let spreadFields = propsToSpread |> List.map (fun (_, expression) -> expression) in
match spreadFields with
| [] -> { pexp_desc=Pexp_record (fields, None); pexp_loc; pexp_attributes=[]}
| [ spreadProps] -> { pexp_desc=Pexp_record (fields, Some spreadProps); pexp_loc; pexp_attributes=[] }
| spreadProps :: _ -> { pexp_desc=Pexp_record (fields, Some spreadProps); pexp_loc; pexp_attributes=[] }
(* make type params for type props<'id, 'name, ...> *)
let makePropsTypeParamsTvar namedTypeList =
namedTypeList
|> List.filter_map (fun (_, label, _, _) ->
if label = "key" || label = "ref" then None else Some (Typ.var label, Invariant))
let extractOptionalCoreType = function
| { ptyp_desc = Ptyp_constr ({txt}, [ coreType ])} when txt = optionIdent -> coreType
| t -> t
(* make type params for make fn arguments *)
(* let make = ({id, name, children}: props<'id, 'name, 'children>) *)
let makePropsTypeParams namedTypeList =
namedTypeList
|> List.filter_map (fun (_isOptional, label, _, _interiorType) ->
if label = "key" || label = "ref" then None
else Some (Typ.var label))
(* make type params for make sig arguments *)
(* let make: React.componentLike<props<string, option<string>>, React.element> *)
let makePropsTypeParamsSig namedTypeList =
namedTypeList
|> List.filter_map (fun (isOptional, label, _, interiorType) ->
if label = "key" || label = "ref" then None
else if isOptional then Some (extractOptionalCoreType interiorType)
else Some interiorType)
(* type props<'id, 'name, ...> = { @optional key: string, @optional id: 'id, ... } *)
let makePropsRecordType propsName loc namedTypeList =
let labelDeclList =
namedTypeList
|> List.map (fun (isOptional, label, _, _interiorType) ->
if label = "key" then Type.field ~loc ~attrs:optionalAttr { txt = label; loc } (keyType Location.none)
else if label = "ref" then Type.field ~loc ~attrs:optionalAttr { txt = label; loc } (refType Location.none)
else if isOptional then Type.field ~loc ~attrs:optionalAttr { txt = label; loc } (Typ.var label)
else Type.field ~loc { txt = label; loc } (Typ.var label))
in
(* 'id, 'className, ... *)
let params = makePropsTypeParamsTvar namedTypeList in
Str.type_ Nonrecursive
[
Type.mk ~loc
~params
{ txt = propsName; loc }
~kind:(Ptype_record labelDeclList);
]
(* type props<'id, 'name, ...> = { @optional key: string, @optional id: 'id, ... } *)
let makePropsRecordTypeSig propsName loc namedTypeList =
let labelDeclList =
namedTypeList
|> List.map (fun (isOptional, label, _, _interiorType) ->
if label = "key" then Type.field ~loc ~attrs:optionalAttr { txt = label; loc } (keyType Location.none)
else if isOptional then Type.field ~loc ~attrs:optionalAttr { txt = label; loc } (Typ.var label)
else Type.field ~loc { txt = label; loc } (Typ.var label))
in
let params = makePropsTypeParamsTvar namedTypeList in
Sig.type_ Nonrecursive
[
Type.mk ~loc
~params
{ txt = propsName ; loc }
~kind:(Ptype_record labelDeclList);
]
(* TODO: some line number might still be wrong *)
let jsxMapper () =
let jsxVersion = ref None in
let transformUppercaseCall3 modulePath mapper loc attrs callExpression callArguments =
let children, argsWithLabels = extractChildren ~loc ~removeLastPositionUnit:true callArguments in
let argsForMake = argsWithLabels in
let childrenExpr = transformChildrenIfListUpper ~loc ~mapper children in
let recursivelyTransformedArgsForMake =
argsForMake |> List.map (fun (label, expression) -> (label, mapper.expr mapper expression))
in
let childrenArg = ref None in
let args =
recursivelyTransformedArgsForMake
@ ( match childrenExpr with
| Exact children -> [ (labelled "children", children) ]
| ListLiteral { pexp_desc = Pexp_array list } when list = [] -> []
| ListLiteral expression ->
(* this is a hack to support react components that introspect into their children *)
childrenArg := Some expression;
[ (labelled "children", Exp.ident ~loc { loc; txt = Ldot (Lident "React", "null") }) ] )
in
let record = recordFromProps callExpression args in
let isCap str =
let first = String.sub str 0 1 [@@raises Invalid_argument] in
let capped = String.uppercase_ascii first in
first = capped
[@@raises Invalid_argument]
in
let ident =
match modulePath with
| Lident _ -> Ldot (modulePath, "make")
| Ldot (_modulePath, value) as fullPath when isCap value -> Ldot (fullPath, "make")
| modulePath -> modulePath
in
let isEmptyRecord { pexp_desc } =
match pexp_desc with
| Pexp_record (labelDecls, _) when List.length labelDecls = 0 -> true
| _ -> false
in
(* check if record which goes to Foo.make({ ... } as record) empty or not
if empty then change it to {key: None} only for upper case jsx
This would be redundant regarding PR progress https://github.com/rescript-lang/syntax/pull/299
*)
let props = if isEmptyRecord record then recordWithOnlyKey ~loc else record in
(* handle key, ref, children *)
(* React.createElement(Component.make, props, ...children) *)
match !childrenArg with
| None ->
Exp.apply ~loc ~attrs
(Exp.ident ~loc { loc; txt = Ldot (Lident "React", "createElement") })
[ (nolabel, Exp.ident ~loc { txt = ident; loc }); (nolabel, props) ]
| Some children ->
Exp.apply ~loc ~attrs
(Exp.ident ~loc { loc; txt = Ldot (Lident "React", "createElementVariadic") })
[ (nolabel, Exp.ident ~loc { txt = ident; loc }); (nolabel, props); (nolabel, children) ]
[@@raises Invalid_argument]
in
let transformLowercaseCall3 mapper loc attrs _callExpression callArguments id =
let children, nonChildrenProps = extractChildren ~loc callArguments in
(* keep the v3 *)
(* let record = recordFromProps callExpression nonChildrenProps in *)
let componentNameExpr = constantString ~loc id in
let childrenExpr = transformChildrenIfList ~loc ~mapper children in
let createElementCall =
match children with
(* [@JSX] div(~children=[a]), coming from <div> a </div> *)
| {
pexp_desc =
( Pexp_construct ({ txt = Lident "::" }, Some { pexp_desc = Pexp_tuple _ })
| Pexp_construct ({ txt = Lident "[]" }, None) );
} ->
"createDOMElementVariadic"
(* [@JSX] div(~children= value), coming from <div> ...(value) </div> *)
| _ ->
raise
(Invalid_argument
"A spread as a DOM element's children don't make sense written together. You can simply remove the \
spread.")
in
let args =
match nonChildrenProps with
| [ _justTheUnitArgumentAtEnd ] ->
[ (* "div" *) (nolabel, componentNameExpr); (* [|moreCreateElementCallsHere|] *) (nolabel, childrenExpr) ]
| nonEmptyProps ->
let propsCall =
Exp.apply ~loc
(Exp.ident ~loc { loc; txt = Ldot (Lident "ReactDOMRe", "domProps") })
(nonEmptyProps |> List.map (fun (label, expression) -> (label, mapper.expr mapper expression)))
in
[
(* "div" *)
(nolabel, componentNameExpr);
(* ReactDOMRe.domProps(~className=blabla, ~foo=bar, ()) *)
(labelled "props", propsCall);
(* [|moreCreateElementCallsHere|] *)
(nolabel, childrenExpr);
]
in
Exp.apply ~loc (* throw away the [@JSX] attribute and keep the others, if any *) ~attrs
(* ReactDOMRe.createElement *)
(Exp.ident ~loc { loc; txt = Ldot (Lident "ReactDOMRe", createElementCall) })
args
[@@raises Invalid_argument]
in
let rec recursivelyTransformNamedArgsForMake mapper expr args newtypes =
let expr = mapper.expr mapper expr in
match expr.pexp_desc with
(* TODO: make this show up with a loc. *)
| Pexp_fun (Labelled "key", _, _, _) | Pexp_fun (Optional "key", _, _, _) ->
raise
(Invalid_argument
"Key cannot be accessed inside of a component. Don't worry - you can always key a component from its \
parent!")
| Pexp_fun (Labelled "ref", _, _, _) | Pexp_fun (Optional "ref", _, _, _) ->
raise (Invalid_argument "Ref cannot be passed as a normal prop. Please use `forwardRef` API instead.")
| Pexp_fun (arg, default, pattern, expression) when isOptional arg || isLabelled arg ->
let () =
match (isOptional arg, pattern, default) with
| true, { ppat_desc = Ppat_constraint (_, { ptyp_desc }) }, None -> (
match ptyp_desc with
| Ptyp_constr ({ txt = Lident "option" }, [ _ ]) -> ()
| _ ->
let currentType =
match ptyp_desc with
| Ptyp_constr ({ txt }, []) -> String.concat "." (Longident.flatten txt)
| Ptyp_constr ({ txt }, _innerTypeArgs) -> String.concat "." (Longident.flatten txt) ^ "(...)"
| _ -> "..."
in
Location.prerr_warning pattern.ppat_loc
(Preprocessor
(Printf.sprintf
"React: optional argument annotations must have explicit `option`. Did you mean \
`option(%s)=?`?"
currentType)) )
| _ -> ()
in
let alias =
match pattern with
| { ppat_desc = Ppat_alias (_, { txt }) | Ppat_var { txt } } -> txt
| { ppat_desc = Ppat_any } -> "_"
| _ -> getLabel arg
in
let type_ = match pattern with { ppat_desc = Ppat_constraint (_, type_) } -> Some type_ | _ -> None in
recursivelyTransformNamedArgsForMake mapper expression
((arg, default, pattern, alias, pattern.ppat_loc, type_) :: args) newtypes
| Pexp_fun (Nolabel, _, { ppat_desc = Ppat_construct ({ txt = Lident "()" }, _) | Ppat_any }, _expression) ->
(args, newtypes, None)
| Pexp_fun
( Nolabel,
_,
{ ppat_desc = Ppat_var { txt } | Ppat_constraint ({ ppat_desc = Ppat_var { txt } }, _) },
_expression ) ->
(args, newtypes, Some txt)
| Pexp_fun (Nolabel, _, pattern, _expression) ->
Location.raise_errorf ~loc:pattern.ppat_loc
"React: react.component refs only support plain arguments and type annotations."
| Pexp_newtype (label, expression) ->
recursivelyTransformNamedArgsForMake mapper expression args (label :: newtypes)
| Pexp_constraint (expression, _typ) ->
recursivelyTransformNamedArgsForMake mapper expression args newtypes
| _ -> (args, newtypes, None)
[@@raises Invalid_argument]
in
let argToType types (name, default, _noLabelName, _alias, loc, type_) =
match (type_, name, default) with
| Some { ptyp_desc = Ptyp_constr ({ txt = Lident "option" }, [ type_ ]) }, name, _ when isOptional name ->
( true,
getLabel name,
[],
{ type_ with ptyp_desc = Ptyp_constr ({ loc = type_.ptyp_loc; txt = optionIdent }, [ type_ ]) } )
:: types
| Some type_, name, Some _default ->
( false,
getLabel name,
[],
{ ptyp_desc = Ptyp_constr ({ loc; txt = optionIdent }, [ type_ ]); ptyp_loc = loc; ptyp_attributes = [] } )
:: types
| Some type_, name, _ -> (false, getLabel name, [], type_) :: types
| None, name, _ when isOptional name ->
( true,
getLabel name,
[],
{
ptyp_desc =
Ptyp_constr
( { loc; txt = optionIdent },
[ { ptyp_desc = Ptyp_var (safeTypeFromValue name); ptyp_loc = loc; ptyp_attributes = [] } ] );
ptyp_loc = loc;
ptyp_attributes = [];
} )
:: types
| None, name, _ when isLabelled name ->
(false, getLabel name, [], { ptyp_desc = Ptyp_var (safeTypeFromValue name); ptyp_loc = loc; ptyp_attributes = [] })
:: types
| _ -> types
[@@raises Invalid_argument]
in
let argWithDefaultValue (name, default, _,_,_,_) =
match default with
| Some default when isOptional name ->
Some (getLabel name, default)
| _ -> None
[@@raises Invalid_argument]
in
let argToConcreteType types (name, loc, type_) =
match name with
| name when isLabelled name -> (false, getLabel name, [], type_) :: types
| name when isOptional name -> (true, getLabel name, [], Typ.constr ~loc { loc; txt = optionIdent } [ type_ ]) :: types
| _ -> types
in
let nestedModules = ref [] in
let transformComponentDefinition mapper structure returnStructures =
match structure with
(* external *)
| {
pstr_loc;
pstr_desc = Pstr_primitive ({ pval_attributes; pval_type } as value_description);
} as pstr -> (
match List.filter hasAttr pval_attributes with
| [] -> structure :: returnStructures
| [ _ ] ->
let rec getPropTypes types ({ ptyp_loc; ptyp_desc } as fullType) =
match ptyp_desc with
| Ptyp_arrow (name, type_, ({ ptyp_desc = Ptyp_arrow _ } as rest)) when isLabelled name || isOptional name
->
getPropTypes ((name, ptyp_loc, type_) :: types) rest
| Ptyp_arrow (Nolabel, _type, rest) -> getPropTypes types rest
| Ptyp_arrow (name, type_, returnValue) when isLabelled name || isOptional name ->
(returnValue, (name, returnValue.ptyp_loc, type_) :: types)
| _ -> (fullType, types)
in
let innerType, propTypes = getPropTypes [] pval_type in
let namedTypeList = List.fold_left argToConcreteType [] propTypes in
let retPropsType = (Typ.constr ~loc:pstr_loc
(Location.mkloc (Lident "props") pstr_loc)
(makePropsTypeParams namedTypeList))
in
(* type props<'id, 'name> = { @optional key: string, @optional id: 'id, ... } *)
let propsRecordType =
makePropsRecordType "props" Location.none
((true, "key", [], keyType pstr_loc) :: (true, "ref", [], refType pstr_loc) :: namedTypeList)
in
(* can't be an arrow because it will defensively uncurry *)
let newExternalType =
Ptyp_constr ({ loc = pstr_loc; txt = Ldot (Lident "React", "componentLike") }, [ retPropsType; innerType ])
in
let newStructure =
{
pstr with
pstr_desc =
Pstr_primitive
{
value_description with
pval_type = { pval_type with ptyp_desc = newExternalType };
pval_attributes = List.filter otherAttrsPure pval_attributes;
};
}
in
propsRecordType :: newStructure :: returnStructures
| _ -> raise (Invalid_argument "Only one react.component call can exist on a component at one time") )
(* let component = ... *)
| { pstr_loc; pstr_desc = Pstr_value (recFlag, valueBindings) } ->
let fileName = filenameFromLoc pstr_loc in
let emptyLoc = Location.in_file fileName in
let mapBinding binding =
if hasAttrOnBinding binding then
let bindingLoc = binding.pvb_loc in
let bindingPatLoc = binding.pvb_pat.ppat_loc in
let binding = { binding with pvb_pat = { binding.pvb_pat with ppat_loc = emptyLoc }; pvb_loc = emptyLoc } in
let fnName = getFnName binding.pvb_pat in
let internalFnName = fnName ^ "$Internal" in
let fullModuleName = makeModuleName fileName !nestedModules fnName in
let modifiedBindingOld binding =
let expression = binding.pvb_expr in
(* TODO: there is a long-tail of unsupported features inside of blocks - Pexp_letmodule , Pexp_letexception , Pexp_ifthenelse *)
let rec spelunkForFunExpression expression =
match expression with
(* let make = (~prop) => ... *)
| { pexp_desc = Pexp_fun _ }
| { pexp_desc = Pexp_newtype _ } -> expression
(* let make = {let foo = bar in (~prop) => ...} *)
| { pexp_desc = Pexp_let (_recursive, _vbs, returnExpression) } ->
(* here's where we spelunk! *)
spelunkForFunExpression returnExpression
(* let make = React.forwardRef((~prop) => ...) *)
| { pexp_desc = Pexp_apply (_wrapperExpression, [ (Nolabel, innerFunctionExpression) ]) } ->
spelunkForFunExpression innerFunctionExpression
| { pexp_desc = Pexp_sequence (_wrapperExpression, innerFunctionExpression) } ->
spelunkForFunExpression innerFunctionExpression
| { pexp_desc = Pexp_constraint (innerFunctionExpression, _typ) } ->
spelunkForFunExpression innerFunctionExpression
| _ ->
raise
(Invalid_argument
"react.component calls can only be on function definitions or component wrappers (forwardRef, \
memo).")
[@@raises Invalid_argument]
in
spelunkForFunExpression expression
in
let modifiedBinding binding =
let hasApplication = ref false in
let wrapExpressionWithBinding expressionFn expression =
Vb.mk ~loc:bindingLoc
~attrs:(List.filter otherAttrsPure binding.pvb_attributes)
(Pat.var ~loc:bindingPatLoc { loc = bindingPatLoc; txt = fnName })
(expressionFn expression)
in
let expression = binding.pvb_expr in
let unerasableIgnoreExp exp =
{ exp with pexp_attributes = unerasableIgnore emptyLoc :: exp.pexp_attributes }
in
(* TODO: there is a long-tail of unsupported features inside of blocks - Pexp_letmodule , Pexp_letexception , Pexp_ifthenelse *)
let rec spelunkForFunExpression expression =
match expression with
(* let make = (~prop) => ... with no final unit *)
| {
pexp_desc =
Pexp_fun
( ((Labelled _ | Optional _) as label),
default,
pattern,
({ pexp_desc = Pexp_fun _ } as internalExpression) );
} ->
let wrap, hasUnit, hasForwardRef, exp = spelunkForFunExpression internalExpression in
( wrap,
hasUnit,
hasForwardRef,
unerasableIgnoreExp { expression with pexp_desc = Pexp_fun (label, default, pattern, exp) } )
(* let make = (()) => ... *)
(* let make = (_) => ... *)
| {
pexp_desc =
Pexp_fun
( Nolabel,
_default,
{ ppat_desc = Ppat_construct ({ txt = Lident "()" }, _) | Ppat_any },
_internalExpression );
} ->
((fun a -> a), true, false, expression)
(* let make = (~prop) => ... *)
| { pexp_desc = Pexp_fun ((Labelled _ | Optional _), _default, _pattern, _internalExpression) } ->
((fun a -> a), false, false, unerasableIgnoreExp expression)
(* let make = (prop) => ... *)
| { pexp_desc = Pexp_fun (_nolabel, _default, pattern, _internalExpression) } ->
if !hasApplication then ((fun a -> a), false, false, unerasableIgnoreExp expression)
else
Location.raise_errorf ~loc:pattern.ppat_loc
"React: props need to be labelled arguments.\n\
\ If you are working with refs be sure to wrap with React.forwardRef.\n\
\ If your component doesn't have any props use () or _ instead of a name."
(* let make = {let foo = bar in (~prop) => ...} *)
| { pexp_desc = Pexp_let (recursive, vbs, internalExpression) } ->
(* here's where we spelunk! *)
let wrap, hasUnit, hasForwardRef, exp = spelunkForFunExpression internalExpression in
(wrap, hasUnit, hasForwardRef, { expression with pexp_desc = Pexp_let (recursive, vbs, exp) })
(* let make = React.forwardRef((~prop) => ...) *)
| { pexp_desc = Pexp_apply (wrapperExpression, [ (Nolabel, internalExpression) ]) } ->
let () = hasApplication := true in
let _, hasUnit, _, exp = spelunkForFunExpression internalExpression in
let hasForwardRef = isForwardRef wrapperExpression in
((fun exp -> Exp.apply wrapperExpression [ (nolabel, exp) ]), hasUnit, hasForwardRef, exp)
| { pexp_desc = Pexp_sequence (wrapperExpression, internalExpression) } ->
let wrap, hasUnit, hasForwardRef, exp = spelunkForFunExpression internalExpression in
(wrap, hasUnit, hasForwardRef, { expression with pexp_desc = Pexp_sequence (wrapperExpression, exp) })
| e -> ((fun a -> a), false, false, e)
in
let wrapExpression, hasUnit, hasForwardRef, expression = spelunkForFunExpression expression in
(wrapExpressionWithBinding wrapExpression, hasUnit, hasForwardRef, expression)
in
let bindingWrapper, _hasUnit, hasForwardRef, expression = modifiedBinding binding in
(* do stuff here! *)
let namedArgList, _newtypes, _forwardRef =
recursivelyTransformNamedArgsForMake mapper (modifiedBindingOld binding) [] []
in
let namedTypeList = List.fold_left argToType [] namedArgList in
(* let _ = ref *)
let vbIgnoreUnusedRef = Vb.mk (Pat.any ()) (Exp.ident (Location.mknoloc (Lident "ref"))) in
(* let ref = ref->Js.Nullable.fromOption *)
let vbRefFromOption = Vb.mk (Pat.var @@ Location.mknoloc "ref")
(Exp.apply (Exp.ident (Location.mknoloc (Ldot (Ldot (Lident "Js", "Nullable"), "fromOption"))))
[(Nolabel, Exp.ident (Location.mknoloc @@ Lident "ref"))])
in
let namedArgWithDefaultValueList = List.filter_map argWithDefaultValue namedArgList in
let vbMatch ((label, default)) =
Vb.mk (Pat.var (Location.mknoloc label))
(Exp.match_ (Exp.ident { txt = Lident label; loc=Location.none })
[
Exp.case
(Pat.construct (Location.mknoloc @@ Lident "Some") (Some (Pat.var ( Location.mknoloc label))))
(Exp.ident (Location.mknoloc @@ Lident label));
Exp.case
(Pat.construct (Location.mknoloc @@ Lident "None") None)
default
])
in
let vbMatchList = List.map vbMatch namedArgWithDefaultValueList in
(* type props = { ... } *)
let propsRecordType =
makePropsRecordType "props" emptyLoc
((true, "key", [], keyType emptyLoc) :: (true, "ref", [], refType pstr_loc) :: namedTypeList)
in
let innerExpression = if hasForwardRef then
Exp.apply (Exp.ident @@ Location.mknoloc @@ Lident "make")
[(Nolabel, Exp.record
[ (Location.mknoloc @@ Lident "ref", Exp.apply ~attrs:optionalAttr
(Exp.ident (Location.mknoloc (Ldot (Ldot (Lident "Js", "Nullable"), "toOption"))))
[ (Nolabel, Exp.ident (Location.mknoloc @@ Lident "ref")) ])
]
(Some (Exp.ident (Location.mknoloc @@ Lident "props"))))]
else Exp.apply (Exp.ident (Location.mknoloc @@ Lident "make"))
[(Nolabel, Exp.ident (Location.mknoloc @@ Lident "props"))]
in
let fullExpression =
(* React component name should start with uppercase letter *)
(* let make = { let \"App" = props => make(props); \"App" } *)
(* let make = React.forwardRef({
let \"App" = (props, ref) => make({...props, ref: @optional (Js.Nullabel.toOption(ref))})
})*)
Exp.fun_ nolabel None
(match namedTypeList with
| [] -> (Pat.var @@ Location.mknoloc "props")
| _ -> (Pat.constraint_
(Pat.var @@ Location.mknoloc "props")
(Typ.constr (Location.mknoloc @@ Lident "props")([Typ.any ()]))))
(if hasForwardRef then Exp.fun_ nolabel None (Pat.var @@ Location.mknoloc "ref") innerExpression
else innerExpression)
in
let fullExpression =
match fullModuleName with
| "" -> fullExpression
| txt ->
Exp.let_ Nonrecursive
[ Vb.mk ~loc:emptyLoc (Pat.var ~loc:emptyLoc { loc = emptyLoc; txt }) fullExpression ]
(Exp.ident ~loc:emptyLoc { loc = emptyLoc; txt = Lident txt })
in
let rec returnedExpression patterns ({ pexp_desc } as expr) =
match pexp_desc with
| Pexp_fun (_arg_label, _default, { ppat_desc = Ppat_construct ({ txt = Lident "()" }, _) | Ppat_any }, expr) ->
(patterns, expr)
| Pexp_fun (arg_label, _default, { ppat_loc }, expr) ->
if isLabelled arg_label || isOptional arg_label then
returnedExpression (({loc = ppat_loc; txt = Lident (getLabel arg_label)}, Pat.var { txt = getLabel arg_label; loc = ppat_loc}) :: patterns) expr
else
returnedExpression patterns expr
| _ -> (patterns, expr)
in
let patternsWithLid, expression = returnedExpression [] expression in
let pattern = (Pat.record ((List.rev patternsWithLid) @ [(Location.mknoloc (Lident "ref"), Pat.var (Location.mknoloc "ref"))]) Closed)
in
(* add patttern matching for optional prop value *)
let expression = if List.length vbMatchList = 0 then expression else (Exp.let_ Nonrecursive vbMatchList expression) in
(* add let _ = ref to ignore unused warning *)
let expression = Exp.let_ Nonrecursive [ vbIgnoreUnusedRef ] expression in
let expression = Exp.let_ Nonrecursive [ vbRefFromOption ] expression in
let expression = Exp.fun_ Nolabel None
begin
Pat.constraint_ pattern
(Typ.constr ~loc:emptyLoc { txt = Lident "props"; loc=emptyLoc }
(makePropsTypeParams namedTypeList))
end
expression
in
(* let make = ({id, name, ...}: props<'id, 'name, ...>) => { ... } *)
let bindings, newBinding =
match recFlag with
| Recursive ->
([
bindingWrapper
(Exp.let_ ~loc:emptyLoc Recursive
[
makeNewBinding binding expression internalFnName;
Vb.mk (Pat.var { loc = emptyLoc; txt = fnName }) fullExpression;
]
(Exp.ident { loc = emptyLoc; txt = Lident fnName }));
], None)
| Nonrecursive ->
([ { binding with pvb_expr = expression; pvb_attributes = [] } ], Some (bindingWrapper fullExpression))
in
(Some propsRecordType, bindings, newBinding)
else (None, [ binding ], None)
[@@raises Invalid_argument]
in (* END of mapBinding fn *)
let structuresAndBinding = List.map mapBinding valueBindings in
let otherStructures (type_, binding, newBinding) (types, bindings, newBindings) =
let types = match type_ with Some type_ -> type_ :: types | None -> types in
let newBindings =
match newBinding with Some newBinding -> newBinding :: newBindings | None -> newBindings
in
(types, binding @ bindings, newBindings)
in
let types, bindings, newBindings = List.fold_right otherStructures structuresAndBinding ([], [], []) in
types
@ [ { pstr_loc; pstr_desc = Pstr_value (recFlag, bindings) } ]
@ ( match newBindings with
| [] -> []
| newBindings -> [ { pstr_loc = emptyLoc; pstr_desc = Pstr_value (recFlag, newBindings) } ] )
@ returnStructures
| structure -> structure :: returnStructures
[@@raises Invalid_argument]
in
let reactComponentTransform mapper structures =
List.fold_right (transformComponentDefinition mapper) structures []
[@@raises Invalid_argument]
in
let transformComponentSignature _mapper signature returnSignatures =
match signature with
| { psig_loc; psig_desc = Psig_value ({ pval_attributes; pval_type } as psig_desc) }
as psig -> (
match List.filter hasAttr pval_attributes with
| [] -> signature :: returnSignatures
| [ _ ] ->
let rec getPropTypes types ({ ptyp_loc; ptyp_desc } as fullType) =
match ptyp_desc with
| Ptyp_arrow (name, type_, ({ ptyp_desc = Ptyp_arrow _ } as rest)) when isOptional name || isLabelled name
->
getPropTypes ((name, ptyp_loc, type_) :: types) rest
| Ptyp_arrow (Nolabel, _type, rest) -> getPropTypes types rest
| Ptyp_arrow (name, type_, returnValue) when isOptional name || isLabelled name ->
(returnValue, (name, returnValue.ptyp_loc, type_) :: types)
| _ -> (fullType, types)
in
let innerType, propTypes = getPropTypes [] pval_type in
let namedTypeList = List.fold_left argToConcreteType [] propTypes in
let retPropsType = (Typ.constr (Location.mkloc (Lident "props") psig_loc)
(makePropsTypeParamsSig namedTypeList))
in
let propsRecordType =
makePropsRecordTypeSig "props" Location.none
((true, "key", [], keyType Location.none) :: (true, "ref", [], refType Location.none) :: namedTypeList)
in
(* can't be an arrow because it will defensively uncurry *)
let newExternalType =
Ptyp_constr ({ loc = psig_loc; txt = Ldot (Lident "React", "componentLike") }, [ retPropsType; innerType ])
in
let newStructure =
{
psig with
psig_desc =
Psig_value
{
psig_desc with
pval_type = { pval_type with ptyp_desc = newExternalType };
pval_attributes = List.filter otherAttrsPure pval_attributes;
};
}
in
propsRecordType :: newStructure :: returnSignatures
| _ -> raise (Invalid_argument "Only one react.component call can exist on a component at one time") )
| signature -> signature :: returnSignatures
[@@raises Invalid_argument]
in
let reactComponentSignatureTransform mapper signatures =
List.fold_right (transformComponentSignature mapper) signatures []
[@@raises Invalid_argument]
in
let transformJsxCall mapper callExpression callArguments attrs =
match callExpression.pexp_desc with
| Pexp_ident caller -> (
match caller with
| { txt = Lident "createElement" } ->
raise (Invalid_argument "JSX: `createElement` should be preceeded by a module name.")
(* Foo.createElement(~prop1=foo, ~prop2=bar, ~children=[], ()) *)
| { loc; txt = Ldot (modulePath, ("createElement" | "make")) } -> (
match !jsxVersion with
| None | Some 3 -> transformUppercaseCall3 modulePath mapper loc attrs callExpression callArguments
| Some _ -> raise (Invalid_argument "JSX: the JSX version must be 3") )
(* div(~prop1=foo, ~prop2=bar, ~children=[bla], ()) *)
(* turn that into
ReactDOMRe.createElement(~props=ReactDOMRe.props(~props1=foo, ~props2=bar, ()), [|bla|]) *)
| { loc; txt = Lident id } -> (
match !jsxVersion with
| None | Some 3 -> transformLowercaseCall3 mapper loc attrs callExpression callArguments id
| Some _ -> raise (Invalid_argument "JSX: the JSX version must be 3") )
| { txt = Ldot (_, anythingNotCreateElementOrMake) } ->
raise
(Invalid_argument
( "JSX: the JSX attribute should be attached to a `YourModuleName.createElement` or \
`YourModuleName.make` call. We saw `" ^ anythingNotCreateElementOrMake ^ "` instead" ))
| { txt = Lapply _ } ->
(* don't think there's ever a case where this is reached *)
raise (Invalid_argument "JSX: encountered a weird case while processing the code. Please report this!") )
| _ -> raise (Invalid_argument "JSX: `createElement` should be preceeded by a simple, direct module name.")
[@@raises Invalid_argument]
in
let signature mapper signature =
default_mapper.signature mapper @@ reactComponentSignatureTransform mapper signature
[@@raises Invalid_argument]
in
let structure mapper structure =
match structure with structures -> default_mapper.structure mapper @@ reactComponentTransform mapper structures
[@@raises Invalid_argument]
in
let expr mapper expression =
match expression with
(* Does the function application have the @JSX attribute? *)
| { pexp_desc = Pexp_apply (callExpression, callArguments); pexp_attributes } -> (
let jsxAttribute, nonJSXAttributes =
List.partition (fun (attribute, _) -> attribute.txt = "JSX") pexp_attributes
in
match (jsxAttribute, nonJSXAttributes) with
(* no JSX attribute *)
| [], _ -> default_mapper.expr mapper expression
| _, nonJSXAttributes -> transformJsxCall mapper callExpression callArguments nonJSXAttributes )
(* is it a list with jsx attribute? Reason <>foo</> desugars to [@JSX][foo]*)
| {
pexp_desc =
( Pexp_construct ({ txt = Lident "::"; loc }, Some { pexp_desc = Pexp_tuple _ })
| Pexp_construct ({ txt = Lident "[]"; loc }, None) );
pexp_attributes;
} as listItems -> (
let jsxAttribute, nonJSXAttributes =
List.partition (fun (attribute, _) -> attribute.txt = "JSX") pexp_attributes
in
match (jsxAttribute, nonJSXAttributes) with
(* no JSX attribute *)
| [], _ -> default_mapper.expr mapper expression
| _, nonJSXAttributes ->
let loc = {loc with loc_ghost= true} in
let fragment = Exp.ident ~loc { loc; txt = Ldot (Lident "ReasonReact", "fragment") } in
let childrenExpr = transformChildrenIfList ~loc ~mapper listItems in
let args =
[ (* "div" *) (nolabel, fragment); (* [|moreCreateElementCallsHere|] *) (nolabel, childrenExpr) ]
in
Exp.apply ~loc (* throw away the [@JSX] attribute and keep the others, if any *) ~attrs:nonJSXAttributes
(* ReactDOMRe.createElement *)
(Exp.ident ~loc { loc; txt = Ldot (Lident "ReactDOMRe", "createElement") })
args )
(* Delegate to the default mapper, a deep identity traversal *)
| e -> default_mapper.expr mapper e
[@@raises Invalid_argument]
in
let module_binding mapper module_binding =
let _ = nestedModules := module_binding.pmb_name.txt :: !nestedModules in
let mapped = default_mapper.module_binding mapper module_binding in
let _ = nestedModules := List.tl !nestedModules in
mapped
[@@raises Failure]
in
{ default_mapper with structure; expr; signature; module_binding }
[@@raises Invalid_argument, Failure]
let rewrite_implementation (code : Parsetree.structure) : Parsetree.structure =
let mapper = jsxMapper () in
mapper.structure mapper code
[@@raises Invalid_argument, Failure]
let rewrite_signature (code : Parsetree.signature) : Parsetree.signature =
let mapper = jsxMapper () in
mapper.signature mapper code
[@@raises Invalid_argument, Failure]