-
Notifications
You must be signed in to change notification settings - Fork 78
/
Copy pathodoc_ast.ml
1879 lines (1787 loc) · 78.4 KB
/
odoc_ast.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
(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* Maxence Guesdon, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 2001 Institut National de Recherche en Informatique et *)
(* en Automatique. *)
(* *)
(* All rights reserved. This file is distributed under the terms of *)
(* the GNU Lesser General Public License version 2.1, with the *)
(* special exception on linking described in the file LICENSE. *)
(* *)
(**************************************************************************)
(** Analysis of implementation files. *)
open Asttypes
open Types
open Typedtree
type typedtree = (Typedtree.structure * Typedtree.module_coercion)
open Odoc_parameter
open Odoc_value
open Odoc_type
open Odoc_extension
open Odoc_exception
open Odoc_class
open Odoc_module
open Odoc_types
(** This module is used to search for structure items by name in a Typedtree.structure.
One function creates two hash tables, which can then be used to search for elements.
Class elements do not use tables.
*)
module Typedtree_search =
struct
type ele =
| M of string
| MT of string
| T of string
| C of string
| CT of string
| X of string
| E of string
| P of string
type tab = (ele, Typedtree.structure_item_desc) Hashtbl.t
type tab_values = (Odoc_module.Name.t, Typedtree.pattern * Typedtree.expression) Hashtbl.t
let iter_val_pattern = function
| Typedtree.Tpat_any -> None
| Typedtree.Tpat_var (name, _, _, _)
| Typedtree.Tpat_alias (_, name, _, _, _, _) -> Some (Name.from_ident name)
| Typedtree.Tpat_tuple _ -> None (* FIXME when we will handle tuples *)
| _ -> None
let add_to_hashes table table_values tt =
match tt with
| Typedtree.Tstr_module mb ->
Option.iter (fun id ->
Hashtbl.add table (M (Name.from_ident id)) tt) mb.mb_id
| Typedtree.Tstr_recmodule mods ->
List.iter
(fun mb ->
Option.iter (fun id ->
Hashtbl.add table (M (Name.from_ident id))
(Typedtree.Tstr_module mb)
) mb.mb_id
)
mods
| Typedtree.Tstr_modtype mtd ->
Hashtbl.add table (MT (Name.from_ident mtd.mtd_id)) tt
| Typedtree.Tstr_typext te -> begin
match te.tyext_constructors with
[] -> assert false
| ext :: _ -> Hashtbl.add table (X (Name.from_ident ext.ext_id)) tt
end
| Typedtree.Tstr_exception ext ->
Hashtbl.add table (E (Name.from_ident ext.tyexn_constructor.ext_id)) tt
| Typedtree.Tstr_type (rf, ident_type_decl_list) ->
List.iter
(fun td ->
Hashtbl.add table (T (Name.from_ident td.typ_id))
(Typedtree.Tstr_type (rf, [td])))
ident_type_decl_list
| Typedtree.Tstr_class info_list ->
List.iter
(fun (ci, s) ->
Hashtbl.add table (C (Name.from_ident ci.ci_id_class))
(Typedtree.Tstr_class [ci, s]))
info_list
| Typedtree.Tstr_class_type info_list ->
List.iter
(fun ((id,_,_) as ci) ->
Hashtbl.add table
(CT (Name.from_ident id))
(Typedtree.Tstr_class_type [ci]))
info_list
| Typedtree.Tstr_value (_, pat_exp_list) ->
List.iter
(fun {vb_pat=pat; vb_expr=exp} ->
match iter_val_pattern pat.Typedtree.pat_desc with
None -> ()
| Some n -> Hashtbl.add table_values n (pat,exp)
)
pat_exp_list
| Typedtree.Tstr_primitive vd ->
Hashtbl.add table (P (Name.from_ident vd.val_id)) tt
| Typedtree.Tstr_open _ -> ()
| Typedtree.Tstr_include _ -> ()
| Typedtree.Tstr_eval _ -> ()
| Typedtree.Tstr_attribute _ -> ()
let tables typedtree =
let t = Hashtbl.create 13 in
let t_values = Hashtbl.create 13 in
List.iter (fun str -> add_to_hashes t t_values str.str_desc) typedtree;
(t, t_values)
let search_module table name =
match Hashtbl.find table (M name) with
(Typedtree.Tstr_module mb) -> mb.mb_expr
| _ -> assert false
let search_module_type table name =
match Hashtbl.find table (MT name) with
| (Typedtree.Tstr_modtype mtd) -> mtd
| _ -> assert false
let search_extension table name =
match Hashtbl.find table (X name) with
| (Typedtree.Tstr_typext tyext) -> tyext
| _ -> assert false
let search_exception table name =
match Hashtbl.find table (E name) with
| (Typedtree.Tstr_exception ext) -> ext
| _ -> assert false
let search_type_declaration table name =
match Hashtbl.find table (T name) with
| (Typedtree.Tstr_type (_, [td])) -> td
| _ -> assert false
let search_class_exp table name =
match Hashtbl.find table (C name) with
| (Typedtree.Tstr_class [(ci, _ )]) ->
let ce = ci.ci_expr in
(
try
let type_decl = search_type_declaration table name in
(ce, type_decl.typ_type.Types.type_params)
with
Not_found ->
(ce, [])
)
| _ -> assert false
let search_class_type_declaration table name =
match Hashtbl.find table (CT name) with
| (Typedtree.Tstr_class_type [(_,_,cltype_decl)]) -> cltype_decl
| _ -> assert false
let search_value table name = Hashtbl.find table name
let search_primitive table name =
match Hashtbl.find table (P name) with
Tstr_primitive vd -> vd.val_val.Types.val_type
| _ -> assert false
let get_nth_inherit_class_expr cls n =
let rec iter cpt = function
| [] ->
raise Not_found
| { cf_desc = Typedtree.Tcf_inherit (_, clexp, _, _, _) } :: q ->
if n = cpt then clexp else iter (cpt+1) q
| _ :: q ->
iter cpt q
in
iter 0 cls.Typedtree.cstr_fields
let search_attribute_type cls name =
let rec iter = function
| [] ->
raise Not_found
| { cf_desc = Typedtree.Tcf_val (_, _, ident, Tcfk_concrete (_, exp), _) } :: _
when Name.from_ident ident = name ->
exp.Typedtree.exp_type
| { cf_desc = Typedtree.Tcf_val (_, _, ident, Tcfk_virtual typ, _) } :: _
when Name.from_ident ident = name ->
typ.Typedtree.ctyp_type
| _ :: q ->
iter q
in
iter cls.Typedtree.cstr_fields
let search_method_expression cls name =
let rec iter = function
| [] ->
raise Not_found
| { cf_desc = Typedtree.Tcf_method (label, _, Tcfk_concrete (_, exp)) } :: _ when label.txt = name ->
exp
| _ :: q ->
iter q
in
iter cls.Typedtree.cstr_fields
end
(** Like {!Odoc_sig.analyze_toplevel_alerts} but acts on a structure. *)
let analyze_toplevel_alerts info ast =
let rec extract_attributes = function
| { Parsetree.pstr_desc = Parsetree.Pstr_attribute attr; _ } :: tl ->
attr :: extract_attributes tl
| _ :: _ | [] -> []
in
Odoc_sig.analyze_alerts info (extract_attributes ast)
module Analyser =
functor (My_ir : Odoc_sig.Info_retriever) ->
struct
module Sig = Odoc_sig.Analyser (My_ir)
(** This variable is used to load a file as a string and retrieve characters from it.*)
let file = Sig.file
(** The name of the analysed file. *)
let file_name = Sig.file_name
(** This function takes two indexes (start and end) and returns the string
corresponding to the indexes in the file global variable. The function
prepare_file must have been called to fill the file global variable.*)
let get_string_of_file = Sig.get_string_of_file
(** This function loads the given file in the file global variable
and sets file_name.*)
let prepare_file = Sig.prepare_file
(** The function used to get the comments in a class. *)
let get_comments_in_class = Sig.get_comments_in_class
(** The function used to get the comments in a module. *)
let get_comments_in_module = Sig.get_comments_in_module
(** This function takes a parameter pattern and builds the
corresponding [parameter] structure. The f_desc function
is used to retrieve a parameter description, if any, from
a parameter name.
*)
let tt_param_info_from_pattern env f_desc pat =
let rec iter_pattern pat =
match pat.pat_desc with
Typedtree.Tpat_var (ident, _, _, _) ->
let name = Name.from_ident ident in
Simple_name { sn_name = name ;
sn_text = f_desc name ;
sn_type = Odoc_env.subst_type env pat.pat_type
}
| Typedtree.Tpat_alias (pat, _, _, _, _, _) ->
iter_pattern pat
| Typedtree.Tpat_tuple patlist ->
Tuple
(List.map (fun (_, p) -> iter_pattern p) patlist,
Odoc_env.subst_type env pat.pat_type)
| Typedtree.Tpat_construct (_, cons_desc, _, _) when
(* we give a name to the parameter only if it is unit *)
Path.same (Btype.cstr_type_path cons_desc) Predef.path_unit
->
(* a () argument, it never has description *)
Simple_name { sn_name = "()" ;
sn_text = None ;
sn_type = Odoc_env.subst_type env pat.pat_type
}
| _ ->
(* implicit pattern matching -> anonymous parameter *)
Simple_name { sn_name = "()" ;
sn_text = None ;
sn_type = Odoc_env.subst_type env pat.pat_type
}
in
iter_pattern pat
(** Analysis of the parameter of a function. Return a list of t_parameter created from
the (pattern, expression) structures encountered. *)
let rec tt_analyse_function_parameters env current_comment_opt params body =
let params =
List.map
(fun param ->
let pat =
match param.fp_kind with
| Tparam_pat pat -> pat
| Tparam_optional_default (pat, _, _) -> pat
in
tt_param_info_from_pattern
env
(Odoc_parameter.desc_from_info_opt current_comment_opt)
pat)
params
in
let params_from_body =
match body with
| Tfunction_body { exp_desc = Texp_function { params; body } } ->
(* We keep this case for two reasons:
1. so odoc continues to gather together all arguments for
functions written as [fun x -> fun y -> fun z -> ...].
2. so we can call [tt_analyse_function_parameters] as a
subroutine of [tt_analyse_method_expression]. Methods
nest all arguments after [self] as a separate [Texp_function]
node.
*)
tt_analyse_function_parameters env current_comment_opt params body
| Tfunction_body _ -> []
| Tfunction_cases { fc_cases = [] } ->
(* FIXME: ppxes/camlp4 can generate this case. *)
[]
| Tfunction_cases { fc_cases = { c_lhs = pattern_param } :: _ } ->
(* implicit pattern matching -> anonymous parameter and no more parameter *)
(* FIXME : label ? *)
let parameter : Odoc_parameter.param_info =
Tuple ([], Odoc_env.subst_type env pattern_param.pat_type)
in
[ parameter ]
in
params @ params_from_body
(** Analysis of a Tstr_value from the typedtree. Create and return a list of [t_value].
@raise Failure if an error occurs.*)
let tt_analyse_value env current_module_name comment_opt loc pat_exp rec_flag attrs =
let (pat, exp) = pat_exp in
let comment_opt = Odoc_sig.analyze_alerts comment_opt attrs in
match (pat.pat_desc, exp.exp_desc) with
(Tpat_var (ident, _, _, _), Texp_function { params; body; _ }) ->
(* a new function is defined *)
let name_pre = Name.from_ident ident in
let name = Name.parens_if_infix name_pre in
let complete_name = Name.concat current_module_name name in
let code =
if !Odoc_global.keep_code then
Some (get_string_of_file loc.Location.loc_start.Lexing.pos_cnum
loc.Location.loc_end.Lexing.pos_cnum)
else
None
in
(* create the value *)
let new_value = {
val_name = complete_name ;
val_info = comment_opt ;
val_type = Odoc_env.subst_type env pat.Typedtree.pat_type ;
val_recursive = rec_flag = Asttypes.Recursive ;
val_parameters =
tt_analyse_function_parameters env comment_opt params body ;
val_code = code ;
val_loc = { loc_impl = Some loc ; loc_inter = None } ;
}
in
[ new_value ]
| (Typedtree.Tpat_var (ident, _, _, _), _) ->
(* a new value is defined *)
let name_pre = Name.from_ident ident in
let name = Name.parens_if_infix name_pre in
let complete_name = Name.concat current_module_name name in
let code =
if !Odoc_global.keep_code then
Some (get_string_of_file loc.Location.loc_start.Lexing.pos_cnum
loc.Location.loc_end.Lexing.pos_cnum)
else
None
in
let new_value = {
val_name = complete_name ;
val_info = comment_opt ;
val_type = Odoc_env.subst_type env pat.Typedtree.pat_type ;
val_recursive = rec_flag = Asttypes.Recursive ;
val_parameters = [] ;
val_code = code ;
val_loc = { loc_impl = Some loc ; loc_inter = None } ;
}
in
[ new_value ]
| (Typedtree.Tpat_tuple _, _) ->
(* new identifiers are defined *)
(* FIXME : by now we don't accept to have global variables defined in tuples *)
[]
| _ ->
(* something else, we don't care ? FIXME *)
[]
(** This function takes a Typedtree.class_expr and returns a string which can stand for the class name.
The name can be "object ... end" if the class expression is not an ident or a class constraint or a class apply. *)
let rec tt_name_of_class_expr clexp =
(*
(
match clexp.Typedtree.cl_desc with
Tclass_ident _ -> prerr_endline "Tclass_ident"
| Tclass_structure _ -> prerr_endline "Tclass_structure"
| Tclass_fun _ -> prerr_endline "Tclass_fun"
| Tclass_apply _ -> prerr_endline "Tclass_apply"
| Tclass_let _ -> prerr_endline "Tclass_let"
| Tclass_constraint _ -> prerr_endline "Tclass_constraint"
);
*)
match clexp.Typedtree.cl_desc with
Typedtree.Tcl_ident (p, _, _) -> Name.from_path p
| Typedtree.Tcl_constraint (class_expr, _, _, _, _)
| Typedtree.Tcl_apply (class_expr, _) -> tt_name_of_class_expr class_expr
(*
| Typedtree.Tclass_fun (_, _, class_expr, _) -> tt_name_of_class_expr class_expr
| Typedtree.Tclass_let (_,_,_, class_expr) -> tt_name_of_class_expr class_expr
*)
| _ -> Odoc_messages.object_end
(** Analysis of a method expression to get the method parameters. *)
let tt_analyse_method_expression env current_method_name comment_opt exp =
match exp.Typedtree.exp_desc with
Typedtree.Texp_function { params; body } ->
let params =
tt_analyse_function_parameters env comment_opt params body
in
begin match params with
| _self :: rest -> rest
| [] ->
(* it is not a function since there are no parameters *)
(* we can't get here normally *)
raise (Failure (Odoc_messages.bad_tree^" "^(Odoc_messages.method_without_param current_method_name)))
end
| _ ->
(* no more parameter *)
[]
(** Analysis of a [Parsetree.class_struture] and a [Typedtree.class_structure] to get a couple
(inherited classes, class elements). *)
let analyse_class_structure env current_class_name tt_class_sig last_pos pos_limit p_cls tt_cls _table =
let rec iter acc_inher acc_fields last_pos = function
| [] ->
let s = get_string_of_file last_pos pos_limit in
let (_, ele_coms) = My_ir.all_special !file_name s in
let ele_comments =
List.fold_left
(fun acc -> fun sc ->
match sc.Odoc_types.i_desc with
None ->
acc
| Some t ->
acc @ [Class_comment t])
[]
ele_coms
in
(acc_inher, acc_fields @ ele_comments)
| item :: q ->
let loc = item.Parsetree.pcf_loc in
match item.Parsetree.pcf_desc with
| (Parsetree.Pcf_inherit (_, p_clexp, _)) ->
let tt_clexp =
let n = List.length acc_inher in
try Typedtree_search.get_nth_inherit_class_expr tt_cls n
with Not_found ->
raise (Failure (
Odoc_messages.inherit_classexp_not_found_in_typedtree n))
in
let (info_opt, ele_comments) =
get_comments_in_class last_pos
p_clexp.Parsetree.pcl_loc.Location.loc_start.Lexing.pos_cnum
in
let text_opt =
match info_opt with None -> None
| Some i -> i.Odoc_types.i_desc in
let name = tt_name_of_class_expr tt_clexp in
let inher =
{
ic_name = Odoc_env.full_class_or_class_type_name env name ;
ic_class = None ;
ic_text = text_opt ;
}
in
iter (acc_inher @ [ inher ]) (acc_fields @ ele_comments)
p_clexp.Parsetree.pcl_loc.Location.loc_end.Lexing.pos_cnum
q
| Parsetree.Pcf_val ({ txt = label }, mutable_flag, k) ->
let virt = match k with Parsetree.Cfk_virtual _ -> true | Parsetree.Cfk_concrete _ -> false in
let complete_name = Name.concat current_class_name label in
let (info_opt, ele_comments) = get_comments_in_class last_pos loc.Location.loc_start.Lexing.pos_cnum in
let type_exp =
try Typedtree_search.search_attribute_type tt_cls label
with Not_found ->
raise (Failure (Odoc_messages.attribute_not_found_in_typedtree complete_name))
in
let code =
if !Odoc_global.keep_code then
Some (get_string_of_file loc.Location.loc_start.Lexing.pos_cnum
loc.Location.loc_end.Lexing.pos_cnum)
else
None
in
let att =
{
att_value = { val_name = complete_name ;
val_info = info_opt ;
val_type = Odoc_env.subst_type env type_exp ;
val_recursive = false ;
val_parameters = [] ;
val_code = code ;
val_loc = { loc_impl = Some loc ; loc_inter = None } ;
} ;
att_mutable = mutable_flag = Asttypes.Mutable ;
att_virtual = virt ;
}
in
iter acc_inher (acc_fields @ ele_comments @ [ Class_attribute att ]) loc.Location.loc_end.Lexing.pos_cnum q
| (Parsetree.Pcf_method ({ txt = label }, private_flag, Parsetree.Cfk_virtual _)) ->
let complete_name = Name.concat current_class_name label in
let (info_opt, ele_comments) = get_comments_in_class last_pos loc.Location.loc_start.Lexing.pos_cnum in
let met_type =
try Odoc_sig.Signature_search.search_method_type label tt_class_sig
with Not_found -> raise (Failure (Odoc_messages.method_type_not_found current_class_name label))
in
let real_type =
match get_desc met_type with
Tarrow (_, _, t, _) ->
t
| _ ->
(* ?!? : not an arrow type ! return the original type *)
met_type
in
let code =
if !Odoc_global.keep_code then
Some (get_string_of_file loc.Location.loc_start.Lexing.pos_cnum
loc.Location.loc_end.Lexing.pos_cnum)
else
None
in
let met =
{
met_value = {
val_name = complete_name ;
val_info = info_opt ;
val_type = Odoc_env.subst_type env real_type ;
val_recursive = false ;
val_parameters = [] ;
val_code = code ;
val_loc = { loc_impl = Some loc ; loc_inter = None } ;
} ;
met_private = private_flag = Asttypes.Private ;
met_virtual = true ;
}
in
(* update the parameter description *)
Odoc_value.update_value_parameters_text met.met_value;
iter acc_inher (acc_fields @ ele_comments @ [ Class_method met ]) loc.Location.loc_end.Lexing.pos_cnum q
| (Parsetree.Pcf_method ({ txt = label }, private_flag, Parsetree.Cfk_concrete _)) ->
let complete_name = Name.concat current_class_name label in
let (info_opt, ele_comments) = get_comments_in_class last_pos loc.Location.loc_start.Lexing.pos_cnum in
let exp =
try Typedtree_search.search_method_expression tt_cls label
with Not_found -> raise (Failure (Odoc_messages.method_not_found_in_typedtree complete_name))
in
let real_type =
match get_desc exp.exp_type with
Tarrow (_, _, t,_) ->
t
| _ ->
(* ?!? : not an arrow type ! return the original type *)
exp.Typedtree.exp_type
in
let code =
if !Odoc_global.keep_code then
Some (get_string_of_file loc.Location.loc_start.Lexing.pos_cnum
loc.Location.loc_end.Lexing.pos_cnum)
else
None
in
let met =
{
met_value = { val_name = complete_name ;
val_info = info_opt ;
val_type = Odoc_env.subst_type env real_type ;
val_recursive = false ;
val_parameters = tt_analyse_method_expression env complete_name info_opt exp ;
val_code = code ;
val_loc = { loc_impl = Some loc ; loc_inter = None } ;
} ;
met_private = private_flag = Asttypes.Private ;
met_virtual = false ;
}
in
(* update the parameter description *)
Odoc_value.update_value_parameters_text met.met_value;
iter acc_inher (acc_fields @ ele_comments @ [ Class_method met ]) loc.Location.loc_end.Lexing.pos_cnum q
| Parsetree.Pcf_constraint (_, _) ->
(* don't give a $*%@ ! *)
iter acc_inher acc_fields loc.Location.loc_end.Lexing.pos_cnum q
| (Parsetree.Pcf_initializer exp) ->
iter acc_inher acc_fields exp.Parsetree.pexp_loc.Location.loc_end.Lexing.pos_cnum q
| Parsetree.Pcf_attribute _ ->
iter acc_inher acc_fields loc.Location.loc_end.Lexing.pos_cnum q
| Parsetree.Pcf_extension _ -> assert false
in
iter [] [] last_pos (p_cls.Parsetree.pcstr_fields)
(** Analysis of a [Parsetree.class_expr] and a [Typedtree.class_expr] to get a pair (class parameters, class kind). *)
let rec analyse_class_kind env current_class_name comment_opt last_pos p_class_expr tt_class_exp table =
match (p_class_expr.Parsetree.pcl_desc, tt_class_exp.Typedtree.cl_desc) with
(Parsetree.Pcl_constr (lid, _), tt_class_exp_desc ) ->
let name =
match tt_class_exp_desc with
Typedtree.Tcl_ident (p,_,_) -> Name.from_path p
| _ ->
(* we try to get the name from the environment. *)
(* FIXME : Unfortunately, we don't have a Tclass_ident :-( even for a class tutu = toto *)
Name.from_longident lid.txt
in
(* Here, type parameters are not present as Types.type_expr,
however they can be found in the class_type *)
let params =
match tt_class_exp.Typedtree.cl_type with
Types.Cty_constr (_p2, type_exp_list, _cltyp) ->
(* cltyp is the class type for [type_exp_list] p *)
type_exp_list
| _ ->
[]
in
([],
Class_constr
{
cco_name = Odoc_env.full_class_name env name ;
cco_class = None ;
cco_type_parameters = List.map (Odoc_env.subst_type env) params ;
} )
| (Parsetree.Pcl_structure p_class_structure, Typedtree.Tcl_structure tt_class_structure) ->
(* we need the class signature to get the type of methods in analyse_class_structure *)
let tt_class_sig =
match tt_class_exp.Typedtree.cl_type with
Types.Cty_signature class_sig -> class_sig
| _ -> raise (Failure "analyse_class_kind: no class signature for a class structure.")
in
let (inherited_classes, class_elements) = analyse_class_structure
env
current_class_name
tt_class_sig
last_pos
p_class_expr.Parsetree.pcl_loc.Location.loc_end.Lexing.pos_cnum
p_class_structure
tt_class_structure
table
in
([],
Class_structure (inherited_classes, class_elements) )
| (Parsetree.Pcl_fun (_label, _expression_opt, _pattern, p_class_expr2),
Typedtree.Tcl_fun (_, pat, _ident_exp_list, tt_class_expr2, _partial)) ->
(* we check that this is not an optional parameter with
a default value. In this case, we look for the good parameter pattern *)
let (parameter, next_tt_class_exp) =
match pat.Typedtree.pat_desc with
Typedtree.Tpat_var (ident, _, _, _) when String.starts_with (Name.from_ident ident) ~prefix:"*opt*" ->
(
(* there must be a Tcl_let just after *)
match tt_class_expr2.Typedtree.cl_desc with
Typedtree.Tcl_let (_, {vb_pat={pat_desc = Typedtree.Tpat_var (id,_,_,_) };
vb_expr=exp} :: _, _, tt_class_expr3) ->
let name = Name.from_ident id in
let new_param = Simple_name
{ sn_name = name ;
sn_text = Odoc_parameter.desc_from_info_opt comment_opt name ;
sn_type = Odoc_env.subst_type env exp.exp_type
}
in
(new_param, tt_class_expr3)
| _ ->
(* strange case *)
(* we create the parameter and add it to the class *)
raise (Failure "analyse_class_kind: strange case")
)
| _ ->
(* no optional parameter with default value, we create the parameter *)
let new_param =
tt_param_info_from_pattern
env
(Odoc_parameter.desc_from_info_opt comment_opt)
pat
in
(new_param, tt_class_expr2)
in
let (params, k) = analyse_class_kind
env current_class_name comment_opt last_pos p_class_expr2
next_tt_class_exp table
in
(parameter :: params, k)
| (Parsetree.Pcl_apply (p_class_expr2, _), Tcl_apply (tt_class_expr2, arg_list)) ->
let applied_name =
(* we want an ident, or else the class applied will appear in the form object ... end,
because if the class applied has no name, the code is kinda ugly, isn't it ? *)
match tt_class_expr2.Typedtree.cl_desc with
Typedtree.Tcl_ident (p,_,_) -> Name.from_path p (* FIXME : obtain the full name *)
| _ ->
(* FIXME : Unfortunately, we don't have a Tclass_ident :-( even for a class tutu = toto *)
match p_class_expr2.Parsetree.pcl_desc with
Parsetree.Pcl_constr (lid, _) ->
(* we try to get the name from the environment. *)
Name.from_longident lid.txt
| _ ->
Odoc_messages.object_end
in
let param_exps = List.fold_left
(fun acc -> fun (_, arg) ->
match arg with
| Omitted _ -> acc
| Arg e -> acc @ [e])
[]
arg_list
in
let param_types =
List.map (fun (e, _) -> e.Typedtree.exp_type) param_exps
in
let params_code =
List.map
(fun (e, _) -> get_string_of_file
e.exp_loc.Location.loc_start.Lexing.pos_cnum
e.exp_loc.Location.loc_end.Lexing.pos_cnum)
param_exps
in
([],
Class_apply
{ capp_name = Odoc_env.full_class_name env applied_name ;
capp_class = None ;
capp_params = param_types ;
capp_params_code = params_code ;
} )
| (Parsetree.Pcl_let (_, _, p_class_expr2), Typedtree.Tcl_let (_, _, _, tt_class_expr2)) ->
(* we don't care about these lets *)
analyse_class_kind
env current_class_name comment_opt last_pos p_class_expr2
tt_class_expr2 table
| (Parsetree.Pcl_constraint (p_class_expr2, _p_class_type2),
Typedtree.Tcl_constraint (tt_class_expr2, _, _, _, _)) ->
let (l, class_kind) = analyse_class_kind
env current_class_name comment_opt last_pos p_class_expr2
tt_class_expr2 table
in
(* FIXME analysis of the class type ? We don't have all the infos. cf. Odoc_sig.analyse_class_type_kind *)
let class_type_kind =
(*Sig.analyse_class_type_kind
env
""
p_class_type2.Parsetree.pcty_loc.Location.loc_start.Lexing.pos_cnum
p_class_type2
tt_class_expr2.Typedtree.cl_type
*)
Class_type { cta_name = Odoc_messages.object_end ;
cta_class = None ; cta_type_parameters = [] }
in
(l, Class_constraint (class_kind, class_type_kind))
| _ ->
raise (Failure "analyse_class_kind: Parsetree and typedtree don't match.")
(** Analysis of a [Parsetree.class_declaration] and a [Typedtree.class_expr] to return a [t_class].*)
let analyse_class env current_module_name comment_opt p_class_decl tt_type_params tt_class_exp table =
let name = p_class_decl.Parsetree.pci_name in
let complete_name = Name.concat current_module_name name.txt in
let loc = p_class_decl.Parsetree.pci_expr.Parsetree.pcl_loc in
let pos_start = loc.Location.loc_start.Lexing.pos_cnum in
let type_parameters = tt_type_params in
let virt = p_class_decl.Parsetree.pci_virt = Asttypes.Virtual in
let cltype = Odoc_env.subst_class_type env tt_class_exp.Typedtree.cl_type in
let (parameters, kind) = analyse_class_kind
env
complete_name
comment_opt
pos_start
p_class_decl.Parsetree.pci_expr
tt_class_exp
table
in
let comment_opt =
Odoc_sig.analyze_alerts comment_opt p_class_decl.Parsetree.pci_attributes
in
{
cl_name = complete_name ;
cl_info = comment_opt ;
cl_type = cltype ;
cl_virtual = virt ;
cl_type_parameters = type_parameters ;
cl_kind = kind ;
cl_parameters = parameters ;
cl_loc = { loc_impl = Some loc ; loc_inter = None } ;
}
(** Get a name from a module expression, or "struct ... end" if the module expression
is not an ident of a constraint on an ident. *)
let rec tt_name_from_module_expr mod_expr =
match mod_expr.Typedtree.mod_desc with
Typedtree.Tmod_ident (p,_) -> Name.from_path p
| Typedtree.Tmod_constraint (m_exp, _, _, _) -> tt_name_from_module_expr m_exp
| Typedtree.Tmod_structure _
| Typedtree.Tmod_functor _
| Typedtree.Tmod_apply _
| Typedtree.Tmod_apply_unit _
| Typedtree.Tmod_unpack _ ->
Odoc_messages.struct_end
(** Get the list of included modules in a module structure of a typed tree. *)
let tt_get_included_module_list tt_structure =
let f acc item =
match item.str_desc with
Typedtree.Tstr_include incl ->
acc @ [
{ (* FIXME : search within modules and module types, with which env ? *)
im_name = tt_name_from_module_expr incl.incl_mod ;
im_module = None ;
im_info = None ;
}
]
| _ ->
acc
in
List.fold_left f [] tt_structure.str_items
(** This function takes a [module element list] of a module and replaces the "dummy" included modules with
the ones found in typed tree structure of the module. *)
let replace_dummy_included_modules module_elements included_modules =
let rec f = function
| ([], _) ->
[]
| ((Element_included_module im) :: q, (im_repl :: im_q)) ->
(Element_included_module { im_repl with im_info = im.im_info })
:: (f (q, im_q))
| ((Element_included_module im) :: q, []) ->
(Element_included_module im) :: q
| (ele :: q, l) ->
ele :: (f (q, l))
in
f (module_elements, included_modules)
(** This function removes the elements of the module which does not
belong to the given module type, if the module type is expanded
and the module has a "structure" kind. *)
let rec filter_module_with_module_type_constraint m mt =
match m.m_kind, mt with
Module_struct l, Types.Mty_signature lsig ->
m.m_kind <- Module_struct (filter_module_elements_with_module_type_constraint l lsig);
m.m_type <- mt;
| _ -> ()
(** This function removes the elements of the module type which does not
belong to the given module type, if the module type is expanded
and the module type has a "structure" kind. *)
and filter_module_type_with_module_type_constraint mtyp mt =
match mtyp.mt_kind, mt with
Some Module_type_struct l, Types.Mty_signature lsig ->
mtyp.mt_kind <- Some (Module_type_struct (filter_module_elements_with_module_type_constraint l lsig));
mtyp.mt_type <- Some mt;
| _ -> ()
and filter_module_elements_with_module_type_constraint l lsig =
let pred ele =
let f = match ele with
Element_module m ->
(function
Types.Sig_module (ident,_,md,_,_) ->
let n1 = Name.simple m.m_name
and n2 = Ident.name ident in
(
match n1 = n2 with
true -> filter_module_with_module_type_constraint m md.md_type; true
| false -> false
)
| _ -> false)
| Element_module_type mt ->
(function
Types.Sig_modtype (ident,{Types.mtd_type=Some t},_) ->
let n1 = Name.simple mt.mt_name
and n2 = Ident.name ident in
(
match n1 = n2 with
true -> filter_module_type_with_module_type_constraint mt t; true
| false -> false
)
| _ -> false)
| Element_value v ->
(function
Types.Sig_value (ident,_, _) ->
let n1 = Name.simple v.val_name
and n2 = Ident.name ident in
n1 = n2
| _ -> false)
| Element_type t ->
(function
Types.Sig_type (ident,_,_,_) ->
(* FIXME: type details can be hidden *)
let n1 = Name.simple t.ty_name
and n2 = Ident.name ident in
n1 = n2
| _ -> false)
| Element_type_extension te ->
let l =
filter_extension_constructors_with_module_type_constraint
te.te_constructors lsig
in
te.te_constructors <- l;
if l <> [] then (fun _ -> true)
else (fun _ -> false)
| Element_exception e ->
(function
Types.Sig_typext (ident,_,_, _) ->
let n1 = Name.simple e.ex_name
and n2 = Ident.name ident in
n1 = n2
| _ -> false)
| Element_class c ->
(function
Types.Sig_class (ident,_,_, _) ->
let n1 = Name.simple c.cl_name
and n2 = Ident.name ident in
n1 = n2
| _ -> false)
| Element_class_type ct ->
(function
Types.Sig_class_type (ident,_,_, _) ->
let n1 = Name.simple ct.clt_name
and n2 = Ident.name ident in
n1 = n2
| _ -> false)
| Element_module_comment _ -> fun _ -> true
| Element_included_module _ -> fun _ -> true
in
List.exists f lsig
in
List.filter pred l
and filter_extension_constructors_with_module_type_constraint l lsig =
let pred xt =
List.exists
(function
Types.Sig_typext (ident, _, _, _) ->
let n1 = Name.simple xt.xt_name
and n2 = Ident.name ident in
n1 = n2
| _ -> false)
lsig
in
List.filter pred l
(** Analysis of a parse tree structure with a typed tree, to return module elements.*)
let rec analyse_structure env current_module_name last_pos pos_limit parsetree typedtree =
let (table, table_values) = Typedtree_search.tables typedtree.str_items in
let rec iter env last_pos = function
[] ->
let s = get_string_of_file last_pos pos_limit in
let (_, ele_coms) = My_ir.all_special !file_name s in
List.fold_left
(fun acc -> fun sc ->
match sc.Odoc_types.i_desc with
None ->
acc
| Some t ->
acc @ [Element_module_comment t])
[]
ele_coms
| item :: q ->
let (comment_opt, ele_comments) =
get_comments_in_module last_pos item.Parsetree.pstr_loc.Location.loc_start.Lexing.pos_cnum
in
let pos_limit2 =
match q with
[] -> pos_limit
| item2 :: _ -> item2.Parsetree.pstr_loc.Location.loc_start.Lexing.pos_cnum
in
let (maybe_more, new_env, elements) = analyse_structure_item_nondesc
env
current_module_name
item.Parsetree.pstr_loc
pos_limit2
comment_opt
item
typedtree
table
table_values
in
ele_comments @ elements @ (iter new_env (item.Parsetree.pstr_loc.Location.loc_end.Lexing.pos_cnum + maybe_more) q)