forked from ocaml-attic/opam-doc.old
-
Notifications
You must be signed in to change notification settings - Fork 1
/
generate.ml
1688 lines (1466 loc) · 61.9 KB
/
generate.ml
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
open Docjson
open Info
open Doctree
open Typedtree
open Location
open Asttypes
open Cow
open Types
type signature = Html.t
type module_content = Html.t
type structure_result =
| Ident of signature * Gentyp.path
| Sig of signature * module_content
let get_path local ?(is_class=false) (p : Path.t) =
Gentyp.path local is_class p
let path_to_html = Gentyp.html_of_path
let generate_html_path local ?(is_class=false) (p : Path.t) : Html.t =
let path = get_path local ~is_class:is_class p in
Gentyp.html_of_path path
(* => non reentrant *)
let glob_env = ref []
let get_full_path_name () =
String.concat "." !glob_env
let current_uri arg =
Uri.of_string (
"?package=" ^ !Opam_doc_config.current_package
^"&module="^get_full_path_name ()
^(match arg with
| `Class n -> "&class="^n
| `Module -> ""))
let add_internal_reference id =
Index.add_internal_reference id !glob_env
let rec add_include_references sig_list =
let rec treat_module_type id = function
| Mty_ident p -> () (* should really do something ? *)
| Mty_signature msig ->
let prev_env = !glob_env in
glob_env := !glob_env @ [id.Ident.name];
add_include_references msig;
glob_env := prev_env;
| Mty_functor (_,_,mtyp) -> treat_module_type id mtyp (* should do more ?*)
in
List.iter
(function
| Sig_value (id,_)
| Sig_type (id, _, _)
| Sig_exception (id, _) ->
add_internal_reference id
| Sig_module (id, mtyp,_) ->
add_internal_reference id;
treat_module_type id mtyp
| Sig_modtype (id, mdecl) ->
add_internal_reference id;
(match mdecl with
Modtype_abstract -> ()
| Modtype_manifest mtyp -> treat_module_type id mtyp
)
| Sig_class (id, _, _)
| Sig_class_type (id, _, _) -> add_internal_reference id
)
sig_list
(* TODO add support for references *)
let rec generate_text_element local elem =
match elem with
| Raw s -> <:html<$str:s$>>
| Code s -> <:html<<code class="code">$str:s$</code>&>>
| PreCode s -> <:html<<pre class="codepre"><code class="code">$str:s$</code></pre>&>>
| Verbatim s -> <:html<<span class="verbatim">$str:s$</span>&>>
| Style(sk, t) -> generate_style local sk t
| List items -> <:html<<ul>$generate_list_items local items$</ul>&>>
| Enum items -> <:html<<ol>$generate_list_items local items$</ol>&>>
| Newline -> <:html<<br/>&>>(*should be : <:html<<p>&>>*)
| Block text -> <:html<<blockquote>$generate_text local text$</blockquote>&>>
| Title(n, lbl, t) -> generate_title n lbl (generate_text local t)
| Ref(rk, s, t) -> (* ref check*)
<:html<TODO reference : $str:s$>>
| Special_ref _ -> <:html<TODO special ref>> (* raise (Failure "Not implemented") *)
| Target _ -> <:html<TODO target>> (* raise (Failure "Not implemented") *)
and generate_text local text =
List.fold_left
(fun acc elem -> <:html<$acc$$generate_text_element local elem$>>)
Html.nil
text
and generate_list_items local items =
List.fold_left
(fun acc item -> <:html<$acc$<li>$generate_text local item$</li>&>>)
Html.nil
items
and generate_style local sk t =
let f elem =
match sk with
| SK_bold -> <:html<<b>$elem$</b>&>>
| SK_italic -> <:html<<i>$elem$</i>&>>
| SK_emphasize -> <:html<<em>$elem$</em>&>>
| SK_center -> <:html<<center>$elem$</center>&>>
| SK_left -> <:html<<div align="left">$elem$</div>&>>
| SK_right -> <:html<<div align="right">$elem$</div>&>>
| SK_superscript -> <:html<<sup class="superscript">$elem$</sup>&>>
| SK_subscript -> <:html<<sub class="subscript">$elem$</sub>&>>
| SK_custom _ -> <:html<TODO custom>>
(*TODO raise (Failure "Not implemented: Custom styles")*)
in
f (generate_text local t)
and generate_title n lbl text =
let sn = (string_of_int n) in
let ftag id html = match n with
| 1 -> <:html<<h1 id="$str:id$">$html$</h1>&>>
| 2 -> <:html<<h2 id="$str:id$">$html$</h2>&>>
| 3 -> <:html<<h3 id="$str:id$">$html$</h3>&>>
| 4 -> <:html<<h4 id="$str:id$">$html$</h4>&>>
| 5 -> <:html<<h5 id="$str:id$">$html$</h5>&>>
| 6 -> <:html<<h6 id="$str:id$">$html$</h6>&>>
| n when n > 6 ->
let clazz = "h"^sn in <:html<<div class="$str:clazz$">$html$</div>&>>
| _ -> Html.nil in
let id = match lbl with
| Some s -> s
| _ -> sn^"_"^"TITLE"
in <:html<<br/>$ftag id text$<br/>&>>
let generate_authors local authors =
List.fold_left
(fun acc author -> <:html<$acc$<span class="author">$str:author$</span>&>>)
<:html<<b>Author(s): </b>&>>
authors
let generate_sees local sees =
let gen_see (sr, t) =
match sr with
| See_url s ->
<:html< <a href="$str:s$">$generate_text local t$</a>&>> (* class="url" *)
| See_file s ->
<:html<<code class="code">$str:s$ </code>$generate_text local t$>>
| See_doc s ->
<:html<<i class="doc">$str:s$ </i>$generate_text local t$>>
in
let elems =
List.fold_left
(fun acc see -> <:html< $acc$ <li>$gen_see see$</li>&>>)
Html.nil
sees in
<:html<<b>See also</b> <ul>$elems$</ul>&>>
let generate_befores local befores =
let gen_before (s, t) =
<:html<<b>Before $str:s$</b> $generate_text local t$>>
in
List.fold_left
(fun acc before -> <:html<$acc$$gen_before before$<br/>&>>)
Html.nil
befores
let generate_params local params =
let gen_param (s, t) =
<:html<<div class="param_info"><code class="code">$str:s$</code> : $generate_text local t$</div>&>>
in
List.fold_left
(fun acc param -> <:html<$acc$$gen_param param$&>>)
Html.nil
params
let generate_raised local raised =
let gen_raised (s, t) =
<:html<<code>$str:s$</code> $generate_text local t$<br/>&>>
in
List.fold_left
(fun acc raised -> <:html<$acc$$gen_raised raised$>>)
Html.nil
raised
(* TODO add support for custom tags *)
let generate_info local info =
let jinfo =
match info.i_desc with
Some t -> generate_text local t
| None -> Html.nil
in
let jinfo =
match info.i_authors with
| [] -> jinfo
| authors ->
<:html<$jinfo$<div class="authors">$generate_authors local authors$</div>&>>
in
let jinfo =
match info.i_version with
| None -> jinfo
| Some s ->
<:html<$jinfo$<div class="version">$str:s$</div>&>>
in
let jinfo =
match info.i_sees with
| [] -> jinfo
| sees ->
<:html<$jinfo$<div class="see">$generate_sees local sees$</div>&>>
in
let jinfo =
match info.i_since with
| None -> jinfo
| Some s ->
<:html<$jinfo$<b>Since</b> $str:s$&>>
in
let jinfo =
match info.i_before with
| [] -> jinfo
| befores ->
<:html<$jinfo$$generate_befores local befores$>>
in
let jinfo =
match info.i_deprecated with
| None -> jinfo
| Some t ->
<:html<$jinfo$<span class="warning">Deprecated.</span> $generate_text local t$<br/>&>>
in
let jinfo =
match info.i_params with
| [] -> jinfo
| params ->
<:html<$jinfo$<div class="parameters">$generate_params local params$</div>&>>
in
let jinfo =
match info.i_raised_exceptions with
| [] -> jinfo
| raised ->
<:html<$jinfo$<b>Raises</b> $generate_raised local raised$&>>
in
let jinfo =
match info.i_return_value with
| None -> jinfo
| Some t ->
<:html<$jinfo$<b>Returns</b> $generate_text local t$>>
in
Html_utils.make_info (Some jinfo)
let generate_info_opt local info =
match info with
| Some i -> Some (generate_info local i)
| None -> None
let generate_info_opt2 local info after_info =
let info = generate_info_opt local info in
let after_info = generate_info_opt local after_info in
match info, after_info with
| None, None -> None
| Some i, None -> Some i
| None, Some i -> Some i
| Some i1, Some i2 -> Some <:html<$i1$$i2$>> (* todo fix the inclusion of comments *)
let generate_typ local typ =
Gentyp.type_scheme local typ.ctyp_type
let generate_typ_param param =
let s =
match param with
Some {txt=s} -> "'" ^ s
| None -> "_"
in
<:html<$str:s$>>
let generate_class_param param =
<:html<$str:"'" ^ param.txt$>>
let generate_variant_constructor local parent_name info (_, {txt=name; _}, args, _) =
let args = List.map (generate_typ local) args in
let info = generate_info_opt local info in
Html_utils.make_variant_cell parent_name name args info
let generate_record_label local parent_name info (_, {txt=name; _}, mut, typ, _) =
let mut = match mut with Mutable -> true | Immutable -> false in
let label_type = generate_typ local typ in
let info = generate_info_opt local info in
Html_utils.make_record_label_cell parent_name name mut label_type info
(* In the future: give the Typedtree.module_type to substitute the signature with
the destructive constraint *)
let generate_with_constraint local (path, _, cstr) =
let path = generate_html_path local path in
match cstr with
| Twith_type td ->
let typ =
match td.typ_manifest with
Some typ -> generate_typ local typ
| None -> assert false
in
<:html<type $path$ = $typ$>>
| Twith_typesubst td ->
let typ =
match td.typ_manifest with
Some typ -> generate_typ local typ
| None -> assert false
in
<:html<type $path$ := $typ$>>
| Twith_module(p, _) ->
<:html<module $path$ = $generate_html_path local p$>>
| Twith_modsubst(p, _) ->
<:html<module $path$ = $generate_html_path local p$>>
let generate_variance = function
| true, false -> `Positive
| false, true -> `Negative
| _, _ -> `None
(* Generate the body of a type declaration *)
let generate_type_kind local parent_name dtk tk =
let infos =
match dtk with
| Some (Dtype_abstract) | None -> []
| Some (Dtype_variant infos) | Some (Dtype_record infos) -> infos
in
match tk with
| Ttype_abstract -> Html.nil
| Ttype_variant cstrs ->
let rec loop cstrs dcstrs acc =
match cstrs with
| ((_, {txt = name; _}, _, _) as cstr) :: rest ->
let dcstrl, drest =
List.partition (fun (n, _) -> n = name) dcstrs
in
let item =
match dcstrl with
| dcstr :: [] ->
generate_variant_constructor local parent_name (snd dcstr) cstr
| [] -> generate_variant_constructor local parent_name None cstr
| _ -> assert false
in
loop rest drest (item :: acc)
| [] ->
if dcstrs <> [] then
Printf.eprintf "[Warning] generate_type_kind : Unbound documentation\n%!";
List.rev acc
in
let items = loop cstrs infos [] in
Html_utils.make_type_table items
| Ttype_record lbls ->
let rec loop lbls dlbls acc =
match lbls with
| ((_, {txt = name}, _, _, _) as lbl) :: rest ->
let dlbll, drest =
List.partition (fun (n, _) -> n = name) dlbls
in
let item =
match dlbll with
| dlbl :: _ ->
generate_record_label local parent_name (snd dlbl) lbl
| [] -> generate_record_label local parent_name None lbl
in
loop rest drest (item :: acc)
| [] ->
if dlbls <> [] then
Printf.eprintf "[Warning] generate_type_kind : Unbound documentation\n%!";
let closing_brac = <:html<<td>}</td>&>> in
List.rev (closing_brac::acc)
in
let items = loop lbls infos [] in
Html_utils.make_type_table items
(** Returns a signature and a path option in order to wrap the content *)
let rec generate_class_type local dclty clty =
let rec loop local dclty clty args_acc =
match dclty, clty.cltyp_desc with
| (Some Dcty_constr|None), Tcty_constr(path, _, cor_list) ->
let params = List.map (generate_typ local) cor_list in
let path = get_path local ~is_class:true path in
let html_path = path_to_html path in
let args =
Html_utils.code "type" (List.fold_left
(fun acc typ -> <:html<$acc$$typ$ -> >>)
Html.nil (List.rev args_acc)) in
let params =
Html_utils.html_of_type_class_param_list
params (List.map (fun _ -> `None) params) (* dummy variance list *)
in
let body = <:html<$args$$params$$html_path$>> in
Ident (body, path)
| dclass_sig, Tcty_signature class_sig ->
let fields : Html.t list =
generate_class_type_fields local
(match dclass_sig with Some Dcty_signature cl -> Some cl | _ -> None)
(* The fields are apparently reversed... *)
(List.rev class_sig.csig_fields) in
let args = match args_acc with
| [] -> Html.nil
| l -> Html_utils.code "type"
(List.fold_left (fun acc typ -> <:html<$acc$$typ$ -> >>) Html.nil l)
in
let body =
let open Html_utils in
<:html<$args$$code "code" (html_of_string "object")$ .. $code "code" (html_of_string "end")$>> in
Sig (<:html<$body$>>, Html_utils.create_class_signature_content fields)
| dclass_type, Tcty_fun (_, core_type, sub_class_type) ->
let arg = generate_typ local core_type in
let sub_dclass_type =
match dclass_type with
| Some (Dcty_fun dcty) -> Some dcty
| None -> None
| _ -> raise (Failure "generate_class_type : Mismatch") in
loop local sub_dclass_type sub_class_type (arg::args_acc)
| _, _ -> assert false
in
loop local dclty clty []
(* TODO : Double check this function *)
and generate_class_type_fields local dclsigl tclsigl =
let open Html_utils in
let process_class_field local tfield =
match tfield.ctf_desc with
| Tctf_inher ctyp ->
let class_result = generate_class_type local None ctyp in
begin
match class_result with
| Ident (s, p) ->
let signature = make_pre <:html<$keyword "inherit"$ $s$>> in
create_class_container "_inherit_field" signature Html.nil (Some p)
| Sig (s,c) ->
let signature = make_pre <:html<$keyword "inherit"$ $s$>> in
create_class_container "_inherit_field" signature c None
end
| Tctf_val (name, mut_f, virt_f, co_typ) ->
let typ = generate_typ local co_typ in
let mut = match mut_f with | Mutable -> true | Immutable -> false in
let virt = match virt_f with | Virtual -> true | Concrete -> false in
let label = keyword "val" in
let label =
if virt then <:html<$label$ $keyword "virtual"$>> else label in
let label =
if mut then <:html<$label$ $keyword "mutable"$>> else label in
let label = generate_mark Opam_doc_config.Value name
<:html<$label$ $str:name$>> in
make_pre <:html<$label$ : $code "code" typ$>>
| Tctf_meth (name, priv_f, co_typ) ->
let typ = generate_typ local co_typ in
let priv = match priv_f with Private -> true | Public -> false in
let label = keyword "method" in
let label =
if priv then <:html<$label$ $keyword "private"$>> else label in
let label = generate_mark Opam_doc_config.Method
name <:html<$label$ $str:name$>> in
make_pre <:html<$label$ : $code "code" typ$>>
| Tctf_virt (name, priv_f, co_typ) ->
let typ = generate_typ local co_typ in
let priv = match priv_f with Private -> true | Public -> false in
let label = keyword "method" in
let label = <:html<$label$ $keyword "virtual"$>> in
let label =
if priv then <:html<$label$ $keyword "private"$>> else label in
let label = generate_mark Opam_doc_config.Method
name <:html<$label$ $str:name$>> in
make_pre <:html<$label$ : $code "code" typ$>>
| Tctf_cstr (co_typ1, co_typ2) ->
let jtyp1 = generate_typ local co_typ1 in
let jtyp2 = generate_typ local co_typ2 in
let label = <:html<$jtyp1$ = $jtyp2$>> in
let label = <:html<$code "type" label$>> in
make_pre <:html<$keyword "constraint"$ $label$>>
in
let generate_class_type_fields_with_doctree local dclsigl tclsigl =
let rec loop (acc: Html.t list) local dclsigl tclsigl is_stopped =
match dclsigl, tclsigl with
| [], r::l ->
Printf.eprintf
"generate_class_type_fields mismatch -- processing without doc\n%!";
List.rev acc @ List.map (process_class_field local) (r::l)
| { dctf_desc=Dctf_comment
; dctf_info=i1
; dctf_after_info=i2}::r, r2 ->
if is_stopped then
loop acc local r r2 is_stopped
else
let info = Html_utils.make_info (generate_info_opt2 local i1 i2) in
loop (info::acc) local r r2 is_stopped
| { dctf_desc=Dctf_stop; _}::r, r2 -> loop acc local r r2 (not is_stopped)
| d::r, t::r2 ->
begin
match d.dctf_desc, t.ctf_desc with
| Dctf_inher dctyp, Tctf_inher ctyp ->
let item =
let class_result = generate_class_type local None ctyp in
begin
match class_result with
| Ident (s, p) ->
let signature = make_pre <:html<$keyword "inherit"$ $s$>> in
create_class_container "_inherit_field" signature Html.nil (Some p)
| Sig (s,c) ->
let signature = make_pre <:html<$keyword "inherit"$ $s$>> in
create_class_container "_inherit_field" signature c None
end
in
if is_stopped then
loop (item::acc) local r r2 is_stopped
else
let info = Html_utils.make_info
(generate_info_opt2 local d.dctf_info d.dctf_after_info) in
loop (info::item::acc) local r r2 is_stopped
| Dctf_val _, Tctf_val _
| Dctf_meth _, Tctf_meth _
| Dctf_meth _, Tctf_virt _
| Dctf_cstr, Tctf_cstr _ ->
let item = process_class_field local t in
if is_stopped then
loop (item::acc) local r r2 is_stopped
else
let info = Html_utils.make_info
(generate_info_opt2 local d.dctf_info d.dctf_after_info) in
loop (info::item::acc) local r r2 is_stopped
| _,_ ->
Printf.eprintf
"generate_class_type_fields mismatch -- processing without doc\n%!";
List.rev acc @ List.map (process_class_field local) (t::r2)
end
| _, [] -> List.rev acc
in
loop [] local dclsigl tclsigl false
in
match dclsigl with
| Some dclsigl -> generate_class_type_fields_with_doctree local dclsigl tclsigl
| None -> List.map (process_class_field local) tclsigl
(** Returns a signature and a path option in order to wrap the content *)
let rec generate_class_expr local dclexpr ci_expr =
(* Gros bugs en vue avec args_acc *)
let rec loop local dclexpr ci_expr args_acc =
match dclexpr, ci_expr.cl_desc with
| dclass_struct, Tcl_structure {cstr_fields=fields; _} ->
let fields = generate_class_fields local
(match dclass_struct with Some (Dcl_structure str) -> Some str | _ -> None)
(* don't reverse the fields this time? :l *)
fields in
let args = match args_acc with
| [] -> Html.nil
| l -> Html_utils.code "type"
(List.fold_left (fun acc typ -> <:html<$acc$$typ$ -> >>) Html.nil l)
in
let signature =
let open Html_utils in
<:html<$args$$code "code" (html_of_string "object")$ .. $code "code" (html_of_string "end")$>> in
Sig (signature, <:html<$Html_utils.create_class_signature_content fields$>>)
| dclass_expr, Tcl_fun (_, pattern, _, class_expr, _) ->
let arg = Gentyp.type_scheme local pattern.pat_type in
loop local
(match dclass_expr with Some (Dcl_fun e) -> Some e | _ -> None)
class_expr (arg::args_acc)
| dclass_apply, Tcl_apply (class_expr, list) ->
(* Not sure... (neither does ocamldoc) *)
loop local
(match dclass_apply with Some (Dcl_apply e) -> Some e | _ -> None)
class_expr args_acc
| dclass_let, Tcl_let (_, _, _, class_expr) ->
(* just process through *)
loop local
(match dclass_let with Some (Dcl_let e) -> Some e | _ -> None)
class_expr args_acc
| (Some Dcl_constr | None), Tcl_constraint (class_expr, _, _, _, _) ->
(* Weird matching: to double check *)
let params, path =
match class_expr.cl_desc with
| Tcl_ident (path, _, co_typ_list) ->
let params = List.map
(generate_typ local)
co_typ_list in
let path = get_path local ~is_class:true path in
params, path
| _ -> assert false
in
let html_path = path_to_html path in
let args =
Html_utils.code "type" (List.fold_left
(fun acc typ -> <:html<$acc$$typ$ -> >>)
Html.nil (List.rev args_acc)) in
let params =
Html_utils.html_of_type_class_param_list
params (List.map (fun _ -> `None) params) (* dummy variance list *)
in
Ident (<:html<$args$$params$$html_path$>>, path)
| dclass_constraint, Tcl_constraint (class_expr, Some ctyp, _, _, _) ->
let cte = loop local
(match dclass_constraint with Some (Dcl_constraint (e,_)) -> Some e | _ -> None)
class_expr [] in
let ctyp = generate_class_type local
(match dclass_constraint with Some (Dcl_constraint (_,t)) -> Some t | _ -> None)
ctyp in
let ctyp_sig = match ctyp with | Ident (s, _) | Sig (s, _) -> s in
let args = match args_acc with
| [] -> Html.nil
| l -> Html_utils.code "type"
(List.fold_left (fun acc typ -> <:html<$acc$$typ$ -> >>) Html.nil l)
in
begin
match cte with
| Ident (s, p) -> Ident (<:html<$args$( $s$ : $ctyp_sig$ )>>, p)
| Sig (s, c) -> Sig (<:html<$args$( $s$ : $ctyp_sig$ )>>, c)
end
| _,_ -> raise (Failure "generate_class_expr: Mismatch")
in
loop local dclexpr ci_expr []
and generate_class_fields local (dclexpr : Doctree.class_field list option) tclexpr =
let extract_type_and_virtual_from_kind = function
(* Type method = < obj type; .. > -> real type
small hack to remove the first part
*)
| Tcfk_virtual co_typ ->
let exp_type = co_typ.ctyp_type in
(match exp_type.desc with
| Tarrow (_, _, ty2, _) -> Gentyp.type_scheme local ty2, false
| _ -> Gentyp.type_scheme local exp_type, false
)
| Tcfk_concrete expr ->
(match expr.exp_type.desc with
| Tarrow (_, _, ty2, _) -> Gentyp.type_scheme local ty2, false
| _ -> Gentyp.type_scheme local expr.exp_type, false
)
in
let process_class_field local tfield =
let open Html_utils in
match tfield.cf_desc with
| Tcf_inher (_, cexpr, _, _, _) ->
let class_result = generate_class_expr local None cexpr in
begin
match class_result with
| Ident (s, p) ->
let signature = make_pre <:html<$keyword "inherit"$ $s$>> in
create_class_container "_inherit_field" signature Html.nil (Some p)
| Sig (s,c) ->
let signature = make_pre <:html<$keyword "inherit"$ $s$>> in
create_class_container "_inherit_field" signature c None
end
| Tcf_val (name, _, mut_f, _, cl_f_kind, _) ->
let typ,virt = extract_type_and_virtual_from_kind cl_f_kind in
let mut = match mut_f with | Mutable -> true | Immutable -> false in
let label = keyword "val" in
let label =
if virt then <:html<$label$ $keyword "virtual"$>> else label in
let label =
if mut then <:html<$label$ $keyword "mutable"$>> else label in
let label = generate_mark Opam_doc_config.Attribute name
<:html<$label$ $str:name$>> in
make_pre <:html<$label$ : $code "code" typ$>>
| Tcf_meth (name, _, priv_f, cl_f_kind, ovr_b) ->
let typ, virt = extract_type_and_virtual_from_kind cl_f_kind in
let priv = match priv_f with Private -> true | Public -> false in
let label = keyword "method" in
let label =
if virt then <:html<$label$ $keyword "virtual"$>> else label in
let label =
if priv then <:html<$label$ $keyword "private"$>> else label in
let label = generate_mark Opam_doc_config.Method
name <:html<$label$ $str:name$>> in
make_pre <:html<$label$ : $code "code" typ$>>
| Tcf_constr (co_typ1, co_typ2) ->
let jtyp1 = generate_typ local co_typ1 in
let jtyp2 = generate_typ local co_typ2 in
let label = <:html<$jtyp1$ = $jtyp2$>> in
let label = <:html<$code "type" label$>> in
make_pre <:html<$keyword "constraint"$ $label$>>
| Tcf_init _ -> Html.nil
in
let generate_class_type_fields_with_doctree local dclexpr tclexpr =
let rec loop (acc: Html.t list) local dclsigl tclsigl is_stopped =
match dclsigl, tclsigl with
| [], r::l ->
Printf.eprintf "generate_class_expr_fields mismatch -- processing without doc\n%!";
List.rev acc @ List.map (process_class_field local) (r::l)
| { dcf_desc=Dcf_comment
; dcf_info=i1 }::r, r2 ->
if is_stopped then
loop acc local r r2 is_stopped
else
let info = Html_utils.make_info (generate_info_opt local i1) in
loop (info::acc) local r r2 is_stopped
| { dcf_desc=Dcf_stop; _}::r, r2 -> loop acc local r r2 (not is_stopped)
| d::r, t::r2 ->
begin
match d.dcf_desc, t.cf_desc with
| Dcf_inher dctyp, Tcf_inher (_, cexpr, _, _, _) ->
let item =
let open Html_utils in
let class_result = generate_class_expr local None cexpr in
begin
match class_result with
| Ident (s, p) ->
let signature = make_pre <:html<$keyword "inherit"$ $s$>> in
create_class_container "_inherit_field" signature Html.nil (Some p)
| Sig (s,c) ->
let signature = make_pre <:html<$keyword "inherit"$ $s$>> in
create_class_container "_inherit_field" signature c None
end
in
if is_stopped then
loop (item::acc) local r r2 is_stopped
else
let info = Html_utils.make_info
(generate_info_opt local d.dcf_info) in
loop (info::item::acc) local r r2 is_stopped
| Dcf_val _, Tcf_val _
| Dcf_meth _, Tcf_meth _
| Dcf_constr, Tcf_constr _ ->
let item = process_class_field local t in
if is_stopped then
loop (item::acc) local r r2 is_stopped
else
let info = Html_utils.make_info
(generate_info_opt local d.dcf_info) in
loop (info::item::acc) local r r2 is_stopped
| _,_ ->
Printf.eprintf "generate_class_expr_fields mismatch -- processing without doc\n%!";
List.rev acc @ List.map (process_class_field local) (t::r2)
end
| _, [] -> List.rev acc
in
loop [] local dclexpr tclexpr false
in
match dclexpr with
| Some dclexpr -> generate_class_type_fields_with_doctree local dclexpr tclexpr
| None -> List.map (process_class_field local) tclexpr
let rec generate_module_type local dmty mty =
let open Html_utils in
match dmty, mty.mty_desc with
| (Some Dmty_ident | None), Tmty_ident(path, _) ->
let real_path = get_path local path in
let path = path_to_html real_path in
Ident (<:html<$code "code" path$&>>, real_path)
| Some (Dmty_signature dsg), Tmty_signature sg ->
let sg_items = generate_signature_item_list local (Some dsg) sg.sig_items in
let signature =
<:html<$code "code" (html_of_string "sig")$ .. $code "code" (html_of_string "end")$>>
in
let module_content = create_module_signature_content sg_items in
Sig (signature, module_content)
| None, Tmty_signature sg ->
let sg_items = generate_signature_item_list local None sg.sig_items in
let signature =
<:html<$code "code" (html_of_string "sig")$ .. $code "code" (html_of_string "end")$>>
in
let module_content = create_module_signature_content sg_items in
Sig (signature, module_content)
| Some (Dmty_functor(darg, dbase)), Tmty_functor(id, _, arg, base) ->
let arg = match generate_module_type local (Some darg) arg with
| Sig (s, _) | Ident (s, _) -> s in
let base = generate_module_type local (Some dbase) base in
let label = <:html<$code "code" (html_of_string "functor (")$>> in
let label = <:html<$label$$code "code" (html_of_string id.Ident.name)$>> in
let label = <:html<$label$<code class="code"> : </code>&>> in
let label = <:html<$label$$arg$$code "code" (html_of_string ") -> ")$>> in
begin
match base with
| Ident (msig, p) ->
Ident (<:html<<div class="sig_block">$label$$msig$</div>&>>, p)
| Sig (msig, content) ->
Sig (<:html<<div class="sig_block">$label$$msig$</div>&>>, content)
end
| None, Tmty_functor(id, _, arg, base) ->
let arg = match generate_module_type local None arg with
| Sig (s, _) | Ident (s, _) -> s in
let base = generate_module_type local None base in
let label = <:html<$code "code" (html_of_string "functor (")$>> in
let label = <:html<$label$$code "code" (html_of_string id.Ident.name)$>> in
let label = <:html<$label$<code class="code"> : </code>&>> in
let label = <:html<$label$$arg$$code "code" (html_of_string ") -> ")$>> in
begin
match base with
| Ident (msig, p) ->
Ident (<:html<<div class="sig_block">$label$$msig$</div>&>>, p)
| Sig (msig, content) ->
Sig (<:html<<div class="sig_block">$label$$msig$</div>&>>, content)
end
| Some (Dmty_with dbase), Tmty_with(base, cnstrs) ->
let base = generate_module_type local (Some dbase) base in
let cnstrs = List.map (generate_with_constraint local) cnstrs in
let signature = <:html<with $insert_between " and " cnstrs$>> in
begin
match base with
| Ident (msig, p) -> Ident (<:html<$msig$ $signature$>>, p)
| Sig (msig, content) -> Sig (<:html<$msig$ $signature$>>, content)
end
| None, Tmty_with(base, cnstrs) ->
let base = generate_module_type local None base in
let cnstrs = List.map (generate_with_constraint local) cnstrs in
let signature = <:html<with $insert_between " and " cnstrs$>> in
begin
match base with
| Ident (msig, p) -> Ident (<:html<$msig$$signature$>>, p)
| Sig (msig, content) -> Sig (<:html<$msig$$signature$>>, content)
end
| Some (Dmty_typeof dexpr), Tmty_typeof mexpr ->
let base = generate_module_expr local (Some dexpr) mexpr in
begin
match base with
| Ident (msig, p) -> Ident (<:html<module type of $msig$>>, p)
| Sig (msig, content) -> Sig (<:html<module type of $msig$>>, content)
end
| None, Tmty_typeof mexpr ->
let base = generate_module_expr local None mexpr in
begin
match base with
| Ident (msig, p) -> Ident (<:html<module type of $msig$>>, p)
| Sig (msig, content) -> Sig (<:html<module type of $msig$>>, content)
end
| _, _ -> raise (Failure "generate_module_type: Mismatch")
and generate_module_expr local dmexpr tmexpr =
let open Html_utils in
match dmexpr, tmexpr.mod_desc with
| (Some Dmod_ident | None), Tmod_ident(path, _) ->
let real_path = get_path local path in
let path = path_to_html real_path in
Ident (<:html<$code "code" path$&>>, real_path)
| Some (Dmod_structure dstr), Tmod_structure str ->
let str_items = generate_structure_item_list local (Some dstr) str.str_items in
let signature =
<:html<$code "code" (html_of_string "sig")$ .. $code "code" (html_of_string "end")$>>
in
let module_content = create_module_signature_content str_items in
Sig (signature, module_content)
| None, Tmod_structure str ->
let str_items = generate_structure_item_list local None str.str_items in
let signature =
<:html<$code "code" (html_of_string "sig")$ .. $code "code" (html_of_string "end")$>>
in
let module_content = create_module_signature_content str_items in
Sig (signature, module_content)
| Some (Dmod_functor(darg, dbase)), Tmod_functor(id, _, arg, base) ->
let arg = match generate_module_type local (Some darg) arg with
| Sig (s, _) | Ident (s, _) -> s in
let base = generate_module_expr local (Some dbase) base in
let label = <:html<$code "code" (html_of_string "functor (")$>> in
let label = <:html<$label$$code "code" (html_of_string id.Ident.name)$>> in
let label = <:html<$label$<code class="code"> : </code>&>> in
let label = <:html<$label$$arg$$code "code" (html_of_string ") -> ")$>> in
begin
match base with
| Ident (msig, p) ->
Ident (<:html<<div class="sig_block">$label$$msig$</div>&>>, p)
| Sig (msig, content) ->
Sig (<:html<<div class="sig_block">$label$$msig$</div>&>>, content)
end
| None, Tmod_functor(id, _, arg, base) ->
let arg = match generate_module_type local None arg with
| Sig (s, _) | Ident (s, _) -> s in
let base = generate_module_expr local None base in
let label = <:html<$code "code" (html_of_string "functor (")$>> in
let label = <:html<$label$$code "code" (html_of_string id.Ident.name)$>> in
let label = <:html<$label$<code class="code"> : </code>&>> in
let label = <:html<$label$$arg$$code "code" (html_of_string ") -> ")$>> in
begin
match base with
| Ident (msig, p) ->
Ident (<:html<<div class="sig_block">$label$$msig$</div>&>>, p)
| Sig (msig, content) ->
Sig (<:html<<div class="sig_block">$label$$msig$</div>&>>, content)
end
| Some (Dmod_apply (dmexpr1, dmexpr2)), Tmod_apply (tmexpr1, tmexpr2, _) ->
let base = generate_module_expr local (Some dmexpr1) tmexpr1 in
let arg = match generate_module_expr local (Some dmexpr2) tmexpr2 with
| Sig (s, _) | Ident (s, _) -> s in
begin
match base with
| Ident (msig, p) ->
Ident (<:html<$msig$($arg$)>>, p)
| Sig (msig, content) ->
Sig (<:html<$msig$($arg$)>>, content)
end
| None, Tmod_apply (tmexpr1, tmexpr2, _) ->
let base = generate_module_expr local None tmexpr1 in
let arg = match generate_module_expr local None tmexpr2 with
| Sig (s, _) | Ident (s, _) -> s in
begin
match base with
| Ident (msig, p) ->
Ident (<:html<$msig$($arg$)>>, p)
| Sig (msig, content) ->
Sig (<:html<$msig$($arg$)>>, content)
end
| dmod_constraint_opt, Tmod_constraint(_, _, Tmodtype_explicit tmty, _) ->
generate_module_type local
(match dmod_constraint_opt with
| Some (Dmod_constraint (_, dmty)) -> Some dmty
| None | _ -> None)
tmty
| dmod_constraint_opt, Tmod_constraint(tmexpr, _, Tmodtype_implicit, _) ->
generate_module_expr local
(match dmod_constraint_opt with
| Some (Dmod_constraint (dmexpr, _)) -> Some dmexpr
| _ -> None)
tmexpr
| (Some Dmod_unpack | None), Tmod_unpack(tmexpr, tmty) ->
(* Not sure what to do with an unpack module (first class module) *)
begin
match tmty with
| Mty_ident path ->
let real_path = get_path local path in
let path = path_to_html real_path in
Ident (<:html<$code "code" path$&>>, real_path)
| _ ->
Printf.eprintf "generate_module_expr: unpack mismatch\n%!";
assert false
end
| _, _ -> raise (Failure "generate_module_type: Mismatch")
(* Discards open, expands module_rec and process signature items *)
and generate_signature_item_list local dsig_items tsig_items =
let rec loop_with_doctree ditems items acc is_stopped =
match ditems, items with
| [], _ -> List.rev acc
| {dsig_desc = Dsig_comment; dsig_info=info; _} :: drest, _ ->
if is_stopped then