-
Notifications
You must be signed in to change notification settings - Fork 86
/
Copy pathodoc_sig.ml
1371 lines (1296 loc) · 59.1 KB
/
odoc_sig.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
(***********************************************************************)
(* *)
(* OCamldoc *)
(* *)
(* 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 Q Public License version 1.0. *)
(* *)
(***********************************************************************)
(** Analysis of interface files. *)
open Misc
open Asttypes
open Types
open Typedtree
open Path
let print_DEBUG s = print_string s ; print_newline ();;
module Name = Odoc_name
open Odoc_parameter
open Odoc_value
open Odoc_type
open Odoc_exception
open Odoc_class
open Odoc_module
open Odoc_types
module Signature_search =
struct
type ele =
| M of string
| MT of string
| V of string
| T of string
| C of string
| CT of string
| E of string
| ER of string
| P of string
type tab = (ele, Types.signature_item) Hashtbl.t
let add_to_hash table signat =
match signat with
Types.Sig_value (ident, _) ->
Hashtbl.add table (V (Name.from_ident ident)) signat
| Types.Sig_exception (ident, _) ->
Hashtbl.add table (E (Name.from_ident ident)) signat
| Types.Sig_type (ident, _, _) ->
Hashtbl.add table (T (Name.from_ident ident)) signat
| Types.Sig_class (ident, _, _) ->
Hashtbl.add table (C (Name.from_ident ident)) signat
| Types.Sig_class_type (ident, _, _) ->
Hashtbl.add table (CT (Name.from_ident ident)) signat
| Types.Sig_module (ident, _, _) ->
Hashtbl.add table (M (Name.from_ident ident)) signat
| Types.Sig_modtype (ident,_) ->
Hashtbl.add table (MT (Name.from_ident ident)) signat
let table signat =
let t = Hashtbl.create 13 in
List.iter (add_to_hash t) signat;
t
let search_value table name =
match Hashtbl.find table (V name) with
| (Types.Sig_value (_, val_desc)) -> val_desc.Types.val_type
| _ -> assert false
let search_exception table name =
match Hashtbl.find table (E name) with
| (Types.Sig_exception (_, type_expr_list)) ->
type_expr_list
| _ -> assert false
let search_type table name =
match Hashtbl.find table (T name) with
| (Types.Sig_type (_, type_decl, _)) -> type_decl
| _ -> assert false
let search_class table name =
match Hashtbl.find table (C name) with
| (Types.Sig_class (_, class_decl, _)) -> class_decl
| _ -> assert false
let search_class_type table name =
match Hashtbl.find table (CT name) with
| (Types.Sig_class_type (_, cltype_decl, _)) -> cltype_decl
| _ -> assert false
let search_module table name =
match Hashtbl.find table (M name) with
| (Types.Sig_module (ident, md, _)) -> md.Types.md_type
| _ -> assert false
let search_module_type table name =
match Hashtbl.find table (MT name) with
| (Types.Sig_modtype (_, {Types.mtd_type = Some module_type})) ->
Some module_type
| (Types.Sig_modtype (_, {Types.mtd_type = None})) ->
None
| _ -> assert false
let search_attribute_type name class_sig =
let (_, _, type_expr) = Types.Vars.find name class_sig.Types.csig_vars in
type_expr
let search_method_type name class_sig =
let fields = Odoc_misc.get_fields class_sig.Types.csig_self in
List.assoc name fields
end
module type Info_retriever =
sig
val all_special : string -> string -> int * (Odoc_types.info list)
val blank_line_outside_simple : string -> string -> bool
val just_after_special : string -> string -> (int * Odoc_types.info option)
val first_special : string -> string -> (int * Odoc_types.info option)
val get_comments :
(Odoc_types.text -> 'a) -> string -> string -> (Odoc_types.info option * 'a list)
end
module Analyser =
functor (My_ir : Info_retriever) ->
struct
(** This variable is used to load a file as a string and retrieve characters from it.*)
let file = ref ""
(** The name of the analysed file. *)
let file_name = ref ""
(** This function takes two indexes (start and end) and return 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 the_start the_end =
try
let s = String.sub !file the_start (the_end-the_start) in
s
with
Invalid_argument _ ->
""
(** This function loads the given file in the file global variable,
and sets file_name.*)
let prepare_file f input_f =
try
let s = Odoc_misc.input_file_as_string input_f in
file := s;
file_name := f
with
e ->
file := "";
raise e
(** The function used to get the comments in a class. *)
let get_comments_in_class pos_start pos_end =
My_ir.get_comments (fun t -> Class_comment t)
!file_name
(get_string_of_file pos_start pos_end)
(** The function used to get the comments in a module. *)
let get_comments_in_module pos_start pos_end =
My_ir.get_comments (fun t -> Element_module_comment t)
!file_name
(get_string_of_file pos_start pos_end)
let merge_infos = Odoc_merge.merge_info_opt Odoc_types.all_merge_options
let name_comment_from_type_kind pos_end pos_limit tk =
match tk with
Parsetree.Ptype_abstract ->
(0, [])
| Parsetree.Ptype_variant cons_core_type_list_list ->
let rec f acc cons_core_type_list_list =
let open Parsetree in
match cons_core_type_list_list with
[] ->
(0, acc)
| pcd :: [] ->
let s = get_string_of_file
pcd.pcd_loc.Location.loc_end.Lexing.pos_cnum
pos_limit
in
let (len, comment_opt) = My_ir.just_after_special !file_name s in
(len, acc @ [ (pcd.pcd_name.txt, comment_opt) ])
| pcd :: (pcd2 :: _ as q) ->
let pos_end_first = pcd.pcd_loc.Location.loc_end.Lexing.pos_cnum in
let pos_start_second = pcd2.pcd_loc.Location.loc_start.Lexing.pos_cnum in
let s = get_string_of_file pos_end_first pos_start_second in
let (_,comment_opt) = My_ir.just_after_special !file_name s in
f (acc @ [pcd.pcd_name.txt, comment_opt]) q
in
f [] cons_core_type_list_list
| Parsetree.Ptype_record name_mutable_type_list (* of (string * mutable_flag * core_type) list*) ->
let open Parsetree in
let rec f = function
[] ->
[]
| {pld_name=name; pld_type=ct} :: [] ->
let pos = ct.Parsetree.ptyp_loc.Location.loc_end.Lexing.pos_cnum in
let s = get_string_of_file pos pos_end in
let (_,comment_opt) = My_ir.just_after_special !file_name s in
[name.txt, comment_opt]
| {pld_name=name; pld_type=ct} :: ({pld_name=name2; pld_type=ct2} as ele2) :: q ->
let pos = ct.Parsetree.ptyp_loc.Location.loc_end.Lexing.pos_cnum in
let pos2 = ct2.Parsetree.ptyp_loc.Location.loc_start.Lexing.pos_cnum in
let s = get_string_of_file pos pos2 in
let (_,comment_opt) = My_ir.just_after_special !file_name s in
(name.txt, comment_opt) :: (f (ele2 :: q))
in
(0, f name_mutable_type_list)
let get_type_kind env name_comment_list type_kind =
match type_kind with
Types.Type_abstract ->
Odoc_type.Type_abstract
| Types.Type_variant l ->
let f {Types.cd_id=constructor_name;cd_args=type_expr_list;cd_res=ret_type} =
let constructor_name = Ident.name constructor_name in
let comment_opt =
try List.assoc constructor_name name_comment_list
with Not_found -> None
in
{
vc_name = constructor_name ;
vc_args = List.map (Odoc_env.subst_type env) type_expr_list ;
vc_ret = may_map (Odoc_env.subst_type env) ret_type;
vc_text = comment_opt
}
in
Odoc_type.Type_variant (List.map f l)
| Types.Type_record (l, _) ->
let f {Types.ld_id=field_name;ld_mutable=mutable_flag;ld_type=type_expr} =
let field_name = Ident.name field_name in
let comment_opt =
try List.assoc field_name name_comment_list
with Not_found -> None
in
{
rf_name = field_name ;
rf_mutable = mutable_flag = Mutable ;
rf_type = Odoc_env.subst_type env type_expr ;
rf_text = comment_opt
}
in
Odoc_type.Type_record (List.map f l)
let erased_names_of_constraints constraints acc =
List.fold_right (fun constraint_ acc ->
match constraint_ with
| Parsetree.Pwith_type _ | Parsetree.Pwith_module _ -> acc
| Parsetree.Pwith_typesubst {Parsetree.ptype_name=s}
| Parsetree.Pwith_modsubst (s, _) ->
Name.Set.add s.txt acc)
constraints acc
let filter_out_erased_items_from_signature erased signature =
if Name.Set.is_empty erased then signature
else List.fold_right (fun sig_item acc ->
let take_item psig_desc = { sig_item with Parsetree.psig_desc } :: acc in
match sig_item.Parsetree.psig_desc with
| Parsetree.Psig_attribute _
| Parsetree.Psig_extension _
| Parsetree.Psig_value _
| Parsetree.Psig_exception _
| Parsetree.Psig_open _
| Parsetree.Psig_include _
| Parsetree.Psig_class _
| Parsetree.Psig_class_type _ as tp -> take_item tp
| Parsetree.Psig_type types ->
(match List.filter (fun td -> not (Name.Set.mem td.Parsetree.ptype_name.txt erased)) types with
| [] -> acc
| types -> take_item (Parsetree.Psig_type types))
| Parsetree.Psig_module {Parsetree.pmd_name=name}
| Parsetree.Psig_modtype {Parsetree.pmtd_name=name} as m ->
if Name.Set.mem name.txt erased then acc else take_item m
| Parsetree.Psig_recmodule mods ->
(match List.filter (fun pmd -> not (Name.Set.mem pmd.Parsetree.pmd_name.txt erased)) mods with
| [] -> acc
| mods -> take_item (Parsetree.Psig_recmodule mods)))
signature []
(** Analysis of the elements of a class, from the information in the parsetree and in the class
signature. @return the couple (inherited_class list, elements).*)
let analyse_class_elements env current_class_name last_pos pos_limit
class_type_field_list class_signature =
let get_pos_limit2 q =
match q with
[] -> pos_limit
| ele2 :: _ ->
let loc = ele2.Parsetree.pctf_loc in
match ele2.Parsetree.pctf_desc with
Parsetree.Pctf_val (_, _, _, _)
| Parsetree.Pctf_method (_, _, _, _)
| Parsetree.Pctf_constraint (_, _) -> loc.Location.loc_start.Lexing.pos_cnum
| Parsetree.Pctf_inherit class_type ->
class_type.Parsetree.pcty_loc.Location.loc_start.Lexing.pos_cnum
| Parsetree.Pctf_extension _ -> assert false
in
let get_method name comment_opt private_flag loc q =
let complete_name = Name.concat current_class_name name in
let typ =
try Signature_search.search_method_type name class_signature
with Not_found ->
raise (Failure (Odoc_messages.method_type_not_found current_class_name name))
in
let subst_typ = Odoc_env.subst_type env typ in
let met =
{
met_value =
{
val_name = complete_name ;
val_info = comment_opt ;
val_type = subst_typ ;
val_recursive = false ;
val_parameters = Odoc_value.dummy_parameter_list subst_typ ;
val_code = None ;
val_loc = { loc_impl = None ; loc_inter = Some loc };
} ;
met_private = private_flag = Asttypes.Private ;
met_virtual = false ;
}
in
let pos_limit2 = get_pos_limit2 q in
let pos_end = loc.Location.loc_end.Lexing.pos_cnum in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file pos_end pos_limit2)
in
met.met_value.val_info <- merge_infos met.met_value.val_info info_after_opt ;
(* update the parameter description *)
Odoc_value.update_value_parameters_text met.met_value;
(met, maybe_more)
in
let rec f last_pos class_type_field_list =
match class_type_field_list with
[] ->
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
([], ele_comments)
| item :: q ->
let loc = item.Parsetree.pctf_loc in
match item.Parsetree.pctf_desc with
| Parsetree.Pctf_val (name, mutable_flag, virtual_flag, _) ->
(* of (string * mutable_flag * core_type option * Location.t)*)
let (comment_opt, eles_comments) = get_comments_in_class last_pos loc.Location.loc_start.Lexing.pos_cnum in
let complete_name = Name.concat current_class_name name in
let typ =
try Signature_search.search_attribute_type name class_signature
with Not_found ->
raise (Failure (Odoc_messages.attribute_type_not_found current_class_name name))
in
let subst_typ = Odoc_env.subst_type env typ in
let att =
{
att_value =
{
val_name = complete_name ;
val_info = comment_opt ;
val_type = subst_typ;
val_recursive = false ;
val_parameters = [] ;
val_code = None ;
val_loc = { loc_impl = None ; loc_inter = Some loc} ;
} ;
att_mutable = mutable_flag = Asttypes.Mutable ;
att_virtual = virtual_flag = Asttypes.Virtual ;
}
in
let pos_limit2 = get_pos_limit2 q in
let pos_end = loc.Location.loc_end.Lexing.pos_cnum in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file pos_end pos_limit2)
in
att.att_value.val_info <- merge_infos att.att_value.val_info info_after_opt ;
let (inher_l, eles) = f (pos_end + maybe_more) q in
(inher_l, eles_comments @ ((Class_attribute att) :: eles))
| Parsetree.Pctf_method (name, private_flag, virtual_flag, _) ->
(* of (string * private_flag * virtual_flag * core_type) *)
let (comment_opt, eles_comments) = get_comments_in_class last_pos loc.Location.loc_start.Lexing.pos_cnum in
let (met, maybe_more) = get_method name comment_opt private_flag loc q in
let met2 =
match virtual_flag with
| Concrete -> met
| Virtual -> { met with met_virtual = true }
in
let (inher_l, eles) = f (loc.Location.loc_end.Lexing.pos_cnum + maybe_more) q in
(inher_l, eles_comments @ ((Class_method met2) :: eles))
| (Parsetree.Pctf_constraint (_, _)) ->
(* of (core_type * core_type) *)
(* A VOIR : cela correspond aux contraintes, non ? on ne les garde pas pour l'instant *)
let (comment_opt, eles_comments) = get_comments_in_class last_pos loc.Location.loc_start.Lexing.pos_cnum in
let (inher_l, eles) = f loc.Location.loc_end.Lexing.pos_cnum q in
(inher_l, eles_comments @ eles)
| Parsetree.Pctf_inherit class_type ->
let loc = class_type.Parsetree.pcty_loc in
let (comment_opt, eles_comments) =
get_comments_in_class last_pos loc.Location.loc_start.Lexing.pos_cnum
in
let pos_limit2 = get_pos_limit2 q in
let pos_end = loc.Location.loc_end.Lexing.pos_cnum in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file pos_end pos_limit2)
in
let comment_opt2 = merge_infos comment_opt info_after_opt in
let text_opt = match comment_opt2 with None -> None | Some i -> i.Odoc_types.i_desc in
let inh =
match class_type.Parsetree.pcty_desc with
Parsetree.Pcty_constr (longident, _) ->
(*of Longident.t * core_type list*)
let name = Name.from_longident longident.txt in
let ic =
{
ic_name = Odoc_env.full_class_or_class_type_name env name ;
ic_class = None ;
ic_text = text_opt ;
}
in
ic
| Parsetree.Pcty_signature _
| Parsetree.Pcty_arrow _ ->
(* we don't have a name for the class signature, so we call it "object ... end" *)
{
ic_name = Odoc_messages.object_end ;
ic_class = None ;
ic_text = text_opt ;
}
| Parsetree.Pcty_extension _ -> assert false
in
let (inher_l, eles) = f (pos_end + maybe_more) q in
(inh :: inher_l , eles_comments @ eles)
| Parsetree.Pctf_extension _ -> assert false
in
f last_pos class_type_field_list
(** Analyse of a .mli parse tree, to get the corresponding elements.
last_pos is the position of the first character which may be used to look for special comments.
*)
let rec analyse_parsetree env signat current_module_name last_pos pos_limit sig_item_list =
let table = Signature_search.table signat in
(* we look for the comment of each item then analyse the item *)
let rec f acc_eles acc_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
let ele_comments =
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
in
acc_eles @ ele_comments
| ele :: q ->
let (assoc_com, ele_comments) = get_comments_in_module
last_pos
ele.Parsetree.psig_loc.Location.loc_start.Lexing.pos_cnum
in
let (maybe_more, new_env, elements) = analyse_signature_item_desc
acc_env
signat
table
current_module_name
ele.Parsetree.psig_loc
ele.Parsetree.psig_loc.Location.loc_start.Lexing.pos_cnum
ele.Parsetree.psig_loc.Location.loc_end.Lexing.pos_cnum
(match q with
[] -> pos_limit
| ele2 :: _ -> ele2.Parsetree.psig_loc.Location.loc_start.Lexing.pos_cnum
)
assoc_com
ele.Parsetree.psig_desc
in
f (acc_eles @ (ele_comments @ elements))
new_env
(ele.Parsetree.psig_loc.Location.loc_end.Lexing.pos_cnum + maybe_more)
(* for the comments of constructors in types,
which are after the constructor definition and can
go beyond ele.Parsetree.psig_loc.Location.loc_end.Lexing.pos_cnum *)
q
in
f [] env last_pos sig_item_list
(** Analyse the given signature_item_desc to create the corresponding module element
(with the given attached comment).*)
and analyse_signature_item_desc env signat table current_module_name
sig_item_loc pos_start_ele pos_end_ele pos_limit comment_opt sig_item_desc =
match sig_item_desc with
Parsetree.Psig_value value_desc ->
let name_pre = value_desc.Parsetree.pval_name in
let type_expr =
try Signature_search.search_value table name_pre.txt
with Not_found ->
raise (Failure (Odoc_messages.value_not_found current_module_name name_pre.txt))
in
let name = Name.parens_if_infix name_pre.txt in
let subst_typ = Odoc_env.subst_type env type_expr in
let v =
{
val_name = Name.concat current_module_name name ;
val_info = comment_opt ;
val_type = subst_typ ;
val_recursive = false ;
val_parameters = Odoc_value.dummy_parameter_list subst_typ ;
val_code = None ;
val_loc = { loc_impl = None ; loc_inter = Some sig_item_loc } ;
}
in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file pos_end_ele pos_limit)
in
v.val_info <- merge_infos v.val_info info_after_opt ;
(* update the parameter description *)
Odoc_value.update_value_parameters_text v;
let new_env = Odoc_env.add_value env v.val_name in
(maybe_more, new_env, [ Element_value v ])
| Parsetree.Psig_exception exception_decl ->
let name = exception_decl.Parsetree.pcd_name in
let types_excep_decl =
try Signature_search.search_exception table name.txt
with Not_found ->
raise (Failure (Odoc_messages.exception_not_found current_module_name name.txt))
in
let e =
{
ex_name = Name.concat current_module_name name.txt ;
ex_info = comment_opt ;
ex_args = List.map (Odoc_env.subst_type env) types_excep_decl.exn_args ;
ex_alias = None ;
ex_loc = { loc_impl = None ; loc_inter = Some sig_item_loc } ;
ex_code =
(
if !Odoc_global.keep_code then
Some (get_string_of_file pos_start_ele pos_end_ele)
else
None
) ;
}
in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file pos_end_ele pos_limit)
in
e.ex_info <- merge_infos e.ex_info info_after_opt ;
let new_env = Odoc_env.add_exception env e.ex_name in
(maybe_more, new_env, [ Element_exception e ])
| Parsetree.Psig_type name_type_decl_list ->
(* we start by extending the environment *)
let new_env =
List.fold_left
(fun acc_env td ->
let complete_name = Name.concat current_module_name td.Parsetree.ptype_name.txt in
Odoc_env.add_type acc_env complete_name
)
env
name_type_decl_list
in
let rec f ?(first=false) acc_maybe_more last_pos name_type_decl_list =
match name_type_decl_list with
[] ->
(acc_maybe_more, [])
| type_decl :: q ->
let name = type_decl.Parsetree.ptype_name in
let (assoc_com, ele_comments) =
if first then
(comment_opt, [])
else
get_comments_in_module
last_pos
type_decl.Parsetree.ptype_loc.Location.loc_start.Lexing.pos_cnum
in
let pos_limit2 =
match q with
[] -> pos_limit
| td :: _ -> td.Parsetree.ptype_loc.Location.loc_start.Lexing.pos_cnum
in
let (maybe_more, name_comment_list) =
name_comment_from_type_kind
type_decl.Parsetree.ptype_loc.Location.loc_end.Lexing.pos_cnum
pos_limit2
type_decl.Parsetree.ptype_kind
in
print_DEBUG ("Type "^name.txt^" : "^(match assoc_com with None -> "sans commentaire" | Some c -> Odoc_misc.string_of_info c));
let f_DEBUG (name, c_opt) = print_DEBUG ("constructor/field "^name^": "^(match c_opt with None -> "sans commentaire" | Some c -> Odoc_misc.string_of_info c)) in
List.iter f_DEBUG name_comment_list;
(* get the information for the type in the signature *)
let sig_type_decl =
try Signature_search.search_type table name.txt
with Not_found ->
raise (Failure (Odoc_messages.type_not_found current_module_name name.txt))
in
(* get the type kind with the associated comments *)
let type_kind = get_type_kind new_env name_comment_list sig_type_decl.Types.type_kind in
let loc_start = type_decl.Parsetree.ptype_loc.Location.loc_start.Lexing.pos_cnum in
let new_end = type_decl.Parsetree.ptype_loc.Location.loc_end.Lexing.pos_cnum + maybe_more in
(* associate the comments to each constructor and build the [Type.t_type] *)
let new_type =
{
ty_name = Name.concat current_module_name name.txt ;
ty_info = assoc_com ;
ty_parameters =
List.map2 (fun p v ->
let (co, cn) = Types.Variance.get_upper v in
(Odoc_env.subst_type new_env p,co, cn))
sig_type_decl.Types.type_params
sig_type_decl.Types.type_variance;
ty_kind = type_kind;
ty_private = sig_type_decl.Types.type_private;
ty_manifest =
(match sig_type_decl.Types.type_manifest with
None -> None
| Some t -> Some (Odoc_env.subst_type new_env t));
ty_loc = { loc_impl = None ; loc_inter = Some sig_item_loc } ;
ty_code =
(
if !Odoc_global.keep_code then
Some (get_string_of_file loc_start new_end)
else
None
) ;
}
in
let (maybe_more2, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file new_end pos_limit2)
in
new_type.ty_info <- merge_infos new_type.ty_info info_after_opt ;
let (new_maybe_more, eles) = f
(maybe_more + maybe_more2)
(new_end + maybe_more2)
q
in
(new_maybe_more, (ele_comments @ [Element_type new_type]) @ eles)
in
let (maybe_more, types) = f ~first: true 0 pos_start_ele name_type_decl_list in
(maybe_more, new_env, types)
| Parsetree.Psig_open _ -> (* A VOIR *)
let ele_comments = match comment_opt with
None -> []
| Some i ->
match i.i_desc with
None -> []
| Some t -> [Element_module_comment t]
in
(0, env, ele_comments)
| Parsetree.Psig_module {Parsetree.pmd_name=name; pmd_type=module_type} ->
let complete_name = Name.concat current_module_name name.txt in
(* get the the module type in the signature by the module name *)
let sig_module_type =
try Signature_search.search_module table name.txt
with Not_found ->
raise (Failure (Odoc_messages.module_not_found current_module_name name.txt))
in
let module_kind = analyse_module_kind env complete_name module_type sig_module_type in
let code_intf =
if !Odoc_global.keep_code then
let loc = module_type.Parsetree.pmty_loc in
let st = loc.Location.loc_start.Lexing.pos_cnum in
let en = loc.Location.loc_end.Lexing.pos_cnum in
Some (get_string_of_file st en)
else
None
in
let new_module =
{
m_name = complete_name ;
m_type = sig_module_type;
m_info = comment_opt ;
m_is_interface = true ;
m_file = !file_name ;
m_kind = module_kind ;
m_loc = { loc_impl = None ; loc_inter = Some sig_item_loc } ;
m_top_deps = [] ;
m_code = None ;
m_code_intf = code_intf ;
m_text_only = false ;
}
in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file pos_end_ele pos_limit)
in
new_module.m_info <- merge_infos new_module.m_info info_after_opt ;
let new_env = Odoc_env.add_module env new_module.m_name in
let new_env2 =
match new_module.m_type with (* A VOIR : cela peut-il etre Tmty_ident ? dans ce cas, on aurait pas la signature *)
Types.Mty_signature s -> Odoc_env.add_signature new_env new_module.m_name ~rel: (Name.simple new_module.m_name) s
| _ -> new_env
in
(maybe_more, new_env2, [ Element_module new_module ])
| Parsetree.Psig_recmodule decls ->
(* we start by extending the environment *)
let new_env =
List.fold_left
(fun acc_env {Parsetree.pmd_name={txt=name}} ->
let complete_name = Name.concat current_module_name name in
let e = Odoc_env.add_module acc_env complete_name in
(* get the information for the module in the signature *)
let sig_module_type =
try Signature_search.search_module table name
with Not_found ->
raise (Failure (Odoc_messages.module_not_found current_module_name name))
in
match sig_module_type with
(* A VOIR : cela peut-il etre Tmty_ident ? dans ce cas, on aurait pas la signature *)
Types.Mty_signature s ->
Odoc_env.add_signature e complete_name ~rel: name s
| _ ->
print_DEBUG "not a Tmty_signature";
e
)
env
decls
in
let rec f ?(first=false) acc_maybe_more last_pos name_mtype_list =
match name_mtype_list with
[] ->
(acc_maybe_more, [])
| {Parsetree.pmd_name=name; pmd_type=modtype} :: q ->
let complete_name = Name.concat current_module_name name.txt in
let loc = modtype.Parsetree.pmty_loc in
let loc_start = loc.Location.loc_start.Lexing.pos_cnum in
let loc_end = loc.Location.loc_end.Lexing.pos_cnum in
let (assoc_com, ele_comments) =
if first then
(comment_opt, [])
else
get_comments_in_module
last_pos
loc_start
in
let pos_limit2 =
match q with
[] -> pos_limit
| _ :: _ -> loc.Location.loc_start.Lexing.pos_cnum
in
(* get the information for the module in the signature *)
let sig_module_type =
try Signature_search.search_module table name.txt
with Not_found ->
raise (Failure (Odoc_messages.module_not_found current_module_name name.txt))
in
(* associate the comments to each constructor and build the [Type.t_type] *)
let module_kind = analyse_module_kind new_env complete_name modtype sig_module_type in
let code_intf =
if !Odoc_global.keep_code then
let st = loc.Location.loc_start.Lexing.pos_cnum in
let en = loc.Location.loc_end.Lexing.pos_cnum in
Some (get_string_of_file st en)
else
None
in
let new_module =
{
m_name = complete_name ;
m_type = sig_module_type;
m_info = assoc_com ;
m_is_interface = true ;
m_file = !file_name ;
m_kind = module_kind ;
m_loc = { loc_impl = None ; loc_inter = Some loc } ;
m_top_deps = [] ;
m_code = None ;
m_code_intf = code_intf ;
m_text_only = false ;
}
in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file loc_end pos_limit2)
in
new_module.m_info <- merge_infos new_module.m_info info_after_opt ;
let (maybe_more2, eles) = f
maybe_more
(loc_end + maybe_more)
q
in
(maybe_more2, (ele_comments @ [Element_module new_module]) @ eles)
in
let (maybe_more, mods) = f ~first: true 0 pos_start_ele decls in
(maybe_more, new_env, mods)
| Parsetree.Psig_modtype {Parsetree.pmtd_name=name; pmtd_type=pmodtype_decl} ->
let complete_name = Name.concat current_module_name name.txt in
let sig_mtype =
try Signature_search.search_module_type table name.txt
with Not_found ->
raise (Failure (Odoc_messages.module_type_not_found current_module_name name.txt))
in
let module_type_kind =
match pmodtype_decl with
None -> None
| Some module_type ->
match sig_mtype with
| Some sig_mtype -> Some (analyse_module_type_kind env complete_name module_type sig_mtype)
| None -> None
in
let mt =
{
mt_name = complete_name ;
mt_info = comment_opt ;
mt_type = sig_mtype ;
mt_is_interface = true ;
mt_file = !file_name ;
mt_kind = module_type_kind ;
mt_loc = { loc_impl = None ; loc_inter = Some sig_item_loc } ;
}
in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file pos_end_ele pos_limit)
in
mt.mt_info <- merge_infos mt.mt_info info_after_opt ;
let new_env = Odoc_env.add_module_type env mt.mt_name in
let new_env2 =
match sig_mtype with (* A VOIR : cela peut-il etre Tmty_ident ? dans ce cas, on aurait pas la signature *)
Some (Types.Mty_signature s) -> Odoc_env.add_signature new_env mt.mt_name ~rel: (Name.simple mt.mt_name) s
| _ -> new_env
in
(maybe_more, new_env2, [ Element_module_type mt ])
| Parsetree.Psig_include (module_type, _attrs) ->
let rec f = function
Parsetree.Pmty_ident longident ->
Name.from_longident longident.txt
| Parsetree.Pmty_signature _ ->
"??"
| Parsetree.Pmty_functor _ ->
"??"
| Parsetree.Pmty_with (mt, _) ->
f mt.Parsetree.pmty_desc
| Parsetree.Pmty_typeof mexpr ->
begin match mexpr.Parsetree.pmod_desc with
Parsetree.Pmod_ident longident -> Name.from_longident longident.txt
| _ -> "??"
end
| Parsetree.Pmty_extension _ -> assert false
in
let name = f module_type.Parsetree.pmty_desc in
let full_name = Odoc_env.full_module_or_module_type_name env name in
let im =
{
im_name = full_name ;
im_module = None ;
im_info = comment_opt;
}
in
(0, env, [ Element_included_module im ]) (* A VOIR : etendre l'environnement ? avec quoi ? *)
| Parsetree.Psig_class class_description_list ->
(* we start by extending the environment *)
let new_env =
List.fold_left
(fun acc_env -> fun class_desc ->
let complete_name = Name.concat current_module_name class_desc.Parsetree.pci_name.txt in
Odoc_env.add_class acc_env complete_name
)
env
class_description_list
in
let rec f ?(first=false) acc_maybe_more last_pos class_description_list =
match class_description_list with
[] ->
(acc_maybe_more, [])
| class_desc :: q ->
let (assoc_com, ele_comments) =
if first then
(comment_opt, [])
else
get_comments_in_module
last_pos
class_desc.Parsetree.pci_loc.Location.loc_start.Lexing.pos_cnum
in
let pos_end = class_desc.Parsetree.pci_loc.Location.loc_end.Lexing.pos_cnum in
let pos_limit2 =
match q with
[] -> pos_limit
| cd :: _ -> cd.Parsetree.pci_loc.Location.loc_start.Lexing.pos_cnum
in
let name = class_desc.Parsetree.pci_name in
let complete_name = Name.concat current_module_name name.txt in
let sig_class_decl =
try Signature_search.search_class table name.txt
with Not_found ->
raise (Failure (Odoc_messages.class_not_found current_module_name name.txt))
in
let sig_class_type = sig_class_decl.Types.cty_type in
let (parameters, class_kind) =
analyse_class_kind
new_env
complete_name
class_desc.Parsetree.pci_loc.Location.loc_start.Lexing.pos_cnum
class_desc.Parsetree.pci_expr
sig_class_type
in
let new_class =
{
cl_name = complete_name ;
cl_info = assoc_com ;
cl_type = Odoc_env.subst_class_type env sig_class_type ;
cl_type_parameters = sig_class_decl.Types.cty_params;
cl_virtual = class_desc.Parsetree.pci_virt = Asttypes.Virtual ;
cl_kind = class_kind ;
cl_parameters = parameters ;
cl_loc = { loc_impl = None ; loc_inter = Some class_desc.Parsetree.pci_loc } ;
}
in
let (maybe_more, info_after_opt) =
My_ir.just_after_special
!file_name
(get_string_of_file pos_end pos_limit2)
in
new_class.cl_info <- merge_infos new_class.cl_info info_after_opt ;
Odoc_class.class_update_parameters_text new_class ;
let (new_maybe_more, eles) =
f maybe_more (pos_end + maybe_more) q
in
(new_maybe_more,
ele_comments @ (( Element_class new_class ) :: eles))
in
let (maybe_more, eles) =
f ~first: true 0 pos_start_ele class_description_list
in
(maybe_more, new_env, eles)
| Parsetree.Psig_class_type class_type_declaration_list ->
(* we start by extending the environment *)
let new_env =
List.fold_left
(fun acc_env -> fun class_type_decl ->
let complete_name = Name.concat current_module_name class_type_decl.Parsetree.pci_name.txt in
Odoc_env.add_class_type acc_env complete_name
)
env
class_type_declaration_list
in
let rec f ?(first=false) acc_maybe_more last_pos class_type_description_list =
match class_type_description_list with
[] ->
(acc_maybe_more, [])
| ct_decl :: q ->
let (assoc_com, ele_comments) =
if first then
(comment_opt, [])
else
get_comments_in_module
last_pos
ct_decl.Parsetree.pci_loc.Location.loc_start.Lexing.pos_cnum
in
let pos_end = ct_decl.Parsetree.pci_loc.Location.loc_end.Lexing.pos_cnum in
let pos_limit2 =
match q with
[] -> pos_limit