package odoc
OCaml Documentation Generator
Install
Dune Dependency
Authors
Maintainers
Sources
odoc-3.0.0.tbz
sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b
sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6
doc/src/odoc.xref2/compile.ml.html
Source file compile.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
(* Phase 1 - compilation *) (* First round of resolving only attempts to resolve paths and fragments, and then only those that don't contain forward paths *) open Odoc_model open Lang module Id = Paths.Identifier module Opt = struct let map f = function Some x -> Some (f x) | None -> None end let type_path : Env.t -> Paths.Path.Type.t -> Paths.Path.Type.t = fun env p -> match p with | `Resolved _ -> p | _ -> ( let cp = Component.Of_Lang.(type_path (empty ()) p) in match Tools.resolve_type_path env cp with | Ok p' -> `Resolved Lang_of.(Path.resolved_type (empty ()) p') | Error _ -> p) and value_path : Env.t -> Paths.Path.Value.t -> Paths.Path.Value.t = fun env p -> match p with | `Resolved _ -> p | _ -> ( let cp = Component.Of_Lang.(value_path (empty ()) p) in match Tools.resolve_value_path env cp with | Ok p' -> `Resolved Lang_of.(Path.resolved_value (empty ()) p') | Error _ -> p) and module_type_path : Env.t -> Paths.Path.ModuleType.t -> Paths.Path.ModuleType.t = fun env p -> match p with | `Resolved _ -> p | _ -> ( let cp = Component.Of_Lang.(module_type_path (empty ()) p) in match Tools.resolve_module_type_path env cp with | Ok p' -> `Resolved Lang_of.(Path.resolved_module_type (empty ()) p') | Error _ -> p) and module_path : Env.t -> Paths.Path.Module.t -> Paths.Path.Module.t = fun env p -> match p with | `Resolved _ -> p | _ -> ( let cp = Component.Of_Lang.(module_path (empty ()) p) in match Tools.resolve_module_path env cp with | Ok p' -> `Resolved Lang_of.(Path.resolved_module (empty ()) p') | Error _ -> p) and class_type_path : Env.t -> Paths.Path.ClassType.t -> Paths.Path.ClassType.t = fun env p -> match p with | `Resolved _ -> p | _ -> ( let cp = Component.Of_Lang.(class_type_path (empty ()) p) in match Tools.resolve_class_type_path env cp with | Ok p' -> `Resolved Lang_of.(Path.resolved_class_type (empty ()) p') | Error _ -> p) let rec unit env t = let open Compilation_unit in { t with content = content env t.id t.content } and implementation env sp = let open Implementation in { sp with source_info = source_info_infos env sp.source_info } and source_info_infos env infos = let open Source_info in let map_doc f v = let documentation = match v.documentation with Some p -> Some (f p) | None -> None in { v with documentation } in List.map (function | v, pos -> let v = match v with | Value v -> Value (map_doc (value_path env) v) | Module v -> Module (map_doc (module_path env) v) | ModuleType v -> ModuleType (map_doc (module_type_path env) v) | Type v -> Type (map_doc (type_path env) v) | Definition _ as d -> d in (v, pos)) infos and content env id = let open Compilation_unit in function | Module sg -> let sg = signature env (id :> Id.Signature.t) sg in Module sg | Pack p -> Pack p and value_ env parent t = let open Value in let container = (parent :> Id.LabelParent.t) in try { t with type_ = type_expression env container t.type_ } with _ -> Errors.report ~what:(`Value t.id) `Compile; t and exception_ env parent e = let open Exception in let container = (parent :> Id.LabelParent.t) in let res = Opt.map (type_expression env container) e.res in let args = type_decl_constructor_argument env container e.args in { e with res; args } and extension env parent t = let open Extension in let container = (parent :> Id.LabelParent.t) in let constructor c = let open Constructor in { c with args = type_decl_constructor_argument env container c.args; res = Opt.map (type_expression env container) c.res; } in let type_path = type_path env t.type_path in let constructors = List.rev_map constructor t.constructors |> List.rev in { t with type_path; constructors } and class_type_expr env parent = let open ClassType in let container = (parent :> Id.LabelParent.t) in function | Constr (path, texps) -> Constr ( class_type_path env path, List.rev_map (type_expression env container) texps |> List.rev ) | Signature s -> Signature (class_signature env parent s) and class_type env c = let open ClassType in let expansion = match let open Odoc_utils.OptionMonad in Env.(lookup_by_id s_class_type) c.id env >>= fun (`ClassType (_, c')) -> Tools.class_signature_of_class_type env c' >>= fun sg -> let cs = Lang_of.class_signature (Lang_of.empty ()) (c.id :> Paths.Identifier.Path.ClassType.t) sg in let compiled = class_signature env (c.id :> Id.ClassSignature.t) cs in Some compiled with | Some _ as exp -> exp | None -> Errors.report ~what:(`Class_type c.id) `Expand; c.expansion in { c with expr = class_type_expr env (c.id :> Id.ClassSignature.t) c.expr; expansion; } and class_signature env parent c = let open ClassSignature in let container = (parent : Id.ClassSignature.t :> Id.LabelParent.t) in let env = Env.open_class_signature c env in let map_item = function | Method m -> Method (method_ env parent m) | InstanceVariable i -> InstanceVariable (instance_variable env parent i) | Constraint cst -> Constraint (class_constraint env container cst) | Inherit ih -> Inherit (inherit_ env parent ih) | Comment c -> Comment c in { c with self = Opt.map (type_expression env container) c.self; items = List.rev_map map_item c.items |> List.rev; } and method_ env parent m = let open Method in let container = (parent :> Id.LabelParent.t) in { m with type_ = type_expression env container m.type_ } and instance_variable env parent i = let open InstanceVariable in let container = (parent :> Id.LabelParent.t) in { i with type_ = type_expression env container i.type_ } and class_constraint env parent cst = let open ClassSignature.Constraint in { cst with left = type_expression env parent cst.left; right = type_expression env parent cst.right; } and inherit_ env parent ih = let open ClassSignature.Inherit in { ih with expr = class_type_expr env parent ih.expr } and class_ env parent c = let open Class in let container = (parent :> Id.LabelParent.t) in let expansion = match let open Odoc_utils.OptionMonad in Env.(lookup_by_id s_class) c.id env >>= fun (`Class (_, c')) -> Tools.class_signature_of_class env c' >>= fun sg -> let cs = Lang_of.class_signature (Lang_of.empty ()) (c.id :> Paths.Identifier.Path.ClassType.t) sg in Some (class_signature env (c.id :> Id.ClassSignature.t) cs) with | Some _ as exp -> exp | None -> Errors.report ~what:(`Class c.id) `Expand; c.expansion in let rec map_decl = function | ClassType expr -> ClassType (class_type_expr env (c.id :> Id.ClassSignature.t) expr) | Arrow (lbl, expr, decl) -> Arrow (lbl, type_expression env container expr, map_decl decl) in { c with type_ = map_decl c.type_; expansion } and module_substitution env m = let open ModuleSubstitution in { m with manifest = module_path env m.manifest } and signature_items : Env.t -> Id.Signature.t -> Signature.item list -> _ = fun initial_env id s -> let open Signature in let rec loop items env xs = match xs with | [] -> (List.rev items, env) | item :: rest -> ( match item with | Module (Nonrec, _) -> assert false | Module (r, m) -> let add_to_env env m = let ty = Component.Delayed.( put (fun () -> Component.Of_Lang.(module_ (empty ()) m))) in Env.add_module (m.id :> Paths.Identifier.Path.Module.t) ty { elements = []; warnings_tag = None } env in let env = match r with | Nonrec -> assert false | And | Ordinary -> env | Rec -> let rec find modules rest = match rest with | Module (And, m') :: sgs -> find (m' :: modules) sgs | Module (_, _) :: _ -> modules | Comment _ :: sgs -> find modules sgs | _ -> modules in let modules = find [ m ] rest in List.fold_left add_to_env env modules in let m' = module_ env m in let env'' = match r with | Nonrec -> assert false | And | Rec -> env | Ordinary -> add_to_env env m' in loop (Module (r, m') :: items) env'' rest | ModuleSubstitution m -> let env' = Env.open_module_substitution m env in loop (ModuleSubstitution (module_substitution env m) :: items) env' rest | Type (r, t) -> let add_to_env env t = let ty = Component.Of_Lang.(type_decl (empty ()) t) in Env.add_type t.id ty env in let env' = match r with | Rec -> assert false | Ordinary -> let rec find types rest = match rest with | Type (And, t) :: sgs -> find (t :: types) sgs | Type (_, _) :: _ -> types | Comment _ :: sgs -> find types sgs | _ -> types in let types = find [ t ] rest in List.fold_left add_to_env env types | And | Nonrec -> env in let t' = type_decl env' t in let env'' = match r with | Rec -> assert false | Ordinary | And -> env' | Nonrec -> add_to_env env' t' in loop (Type (r, t') :: items) env'' rest | TypeSubstitution t -> let env' = Env.open_type_substitution t env in loop (TypeSubstitution (type_decl env t) :: items) env' rest | ModuleType mt -> let m' = module_type env mt in let ty = Component.Of_Lang.(module_type (empty ()) m') in let env' = Env.add_module_type mt.id ty env in loop (ModuleType (module_type env mt) :: items) env' rest | ModuleTypeSubstitution mt -> let env' = Env.open_module_type_substitution mt env in loop (ModuleTypeSubstitution (module_type_substitution env mt) :: items) env' rest | Value v -> loop (Value (value_ env id v) :: items) env rest | Comment c -> loop (Comment c :: items) env rest | TypExt t -> loop (TypExt (extension env id t) :: items) env rest | Exception e -> loop (Exception (exception_ env id e) :: items) env rest | Class (r, c) -> let ty = Component.Of_Lang.(class_ (empty ()) c) in let env' = Env.add_class c.id ty env in let c' = class_ env' id c in loop (Class (r, c') :: items) env' rest | ClassType (r, c) -> let ty = Component.Of_Lang.(class_type (empty ()) c) in let env' = Env.add_class_type c.id ty env in let c' = class_type env' c in loop (ClassType (r, c') :: items) env' rest | Include i -> let i', env' = include_ env i in loop (Include i' :: items) env' rest | Open o -> loop (Open o :: items) env rest) in loop [] initial_env s and module_type_substitution env mt = let open ModuleTypeSubstitution in { mt with manifest = module_type_expr env (mt.id :> Id.Signature.t) mt.manifest; } and signature : Env.t -> Id.Signature.t -> Signature.t -> _ = fun env id s -> if s.compiled then s else let items, _ = signature_items env id s.items in { Signature.items; compiled = true; removed = s.removed; doc = s.doc (* comments are ignored while compiling *); } and module_ : Env.t -> Module.t -> Module.t = fun env m -> let open Module in { m with type_ = module_decl env (m.id :> Id.Signature.t) m.type_ } and module_decl : Env.t -> Id.Signature.t -> Module.decl -> Module.decl = fun env id decl -> let open Module in match decl with | ModuleType expr -> ModuleType (module_type_expr env id expr) | Alias (p, expn) -> Alias (module_path env p, expn) and include_decl : Env.t -> Id.Signature.t -> Include.decl -> Include.decl = fun env id decl -> let open Include in match decl with | ModuleType expr -> ModuleType (u_module_type_expr env id expr) | Alias p -> Alias (module_path env p) and module_type : Env.t -> ModuleType.t -> ModuleType.t = fun env m -> let open ModuleType in let sg_id = (m.id :> Id.Signature.t) in let expr = match m.expr with | None -> None | Some e -> Some (module_type_expr env sg_id ~expand_paths:false e) in { m with expr } and include_ : Env.t -> Include.t -> Include.t * Env.t = fun env i -> let open Include in let decl = Component.Of_Lang.(include_decl (empty ()) i.decl) in let get_expansion () = match let open Odoc_utils.ResultMonad in match decl with | Alias p -> Tools.expansion_of_module_path env ~strengthen:true p >>= fun exp -> Tools.assert_not_functor exp | ModuleType mty -> Tools.signature_of_u_module_type_expr env mty with | Error e -> Errors.report ~what:(`Include decl) ~tools_error:e `Expand; i.expansion | Ok sg -> let map = Lang_of.with_shadowed i.expansion.shadowed in let sg' = match i.strengthened with | Some p -> let cp = Component.Of_Lang.(module_path (empty ()) p) in Strengthen.signature cp sg | None -> sg in let e = Lang_of.(simple_expansion map i.parent (Signature sg')) in let expansion_sg = match e with | ModuleType.Signature sg -> sg | _ -> failwith "Expansion shouldn't be anything other than a signature" in { i.expansion with content = expansion_sg } in let expansion = get_expansion () in let items, env' = signature_items env i.parent expansion.content.items in let expansion = { expansion with content = { expansion.content with items; compiled = true }; } in ({ i with decl = include_decl env i.parent i.decl; expansion }, env') and simple_expansion : Env.t -> Id.Signature.t -> ModuleType.simple_expansion -> ModuleType.simple_expansion = fun env id e -> match e with | Signature sg -> Signature (signature env id sg) | Functor (param, sg) -> let env' = Env.add_functor_parameter param env in Functor ( functor_parameter env param, simple_expansion env' (Paths.Identifier.Mk.result id) sg ) and functor_parameter : Env.t -> FunctorParameter.t -> FunctorParameter.t = fun env param -> match param with | Unit -> Unit | Named arg -> Named (functor_parameter_parameter env arg) and functor_parameter_parameter : Env.t -> FunctorParameter.parameter -> FunctorParameter.parameter = fun env a -> { a with expr = module_type_expr env (a.id :> Id.Signature.t) a.expr } and module_type_expr_sub id ~fragment_root (sg_res, env, subs) lsub = let open Odoc_utils.ResultMonad in match sg_res with | Error _ -> (sg_res, env, lsub :: subs) | Ok sg -> ( let lang_of_map = Lang_of.with_fragment_root fragment_root in let env = Env.add_fragment_root sg env in let sg_and_sub = match lsub with | Odoc_model.Lang.ModuleType.ModuleEq (frag, decl) -> let cfrag = Component.Of_Lang.(module_fragment (empty ()) frag) in let cfrag', frag' = match Tools.resolve_module_fragment env (fragment_root, sg) cfrag with | Some cfrag' -> ( `Resolved cfrag', `Resolved (Lang_of.Path.resolved_module_fragment lang_of_map cfrag') ) | None -> Errors.report ~what:(`With_module cfrag) `Resolve; (cfrag, frag) in let decl' = module_decl env id decl in let cdecl' = Component.Of_Lang.(module_decl (empty ()) decl') in let resolved_csub = Component.ModuleType.ModuleEq (cfrag', cdecl') in Tools.fragmap env resolved_csub sg >>= fun sg' -> Ok (sg', Odoc_model.Lang.ModuleType.ModuleEq (frag', decl')) | TypeEq (frag, eqn) -> let cfrag = Component.Of_Lang.(type_fragment (empty ()) frag) in let cfrag', frag' = match Tools.resolve_type_fragment env (fragment_root, sg) cfrag with | Some cfrag' -> ( `Resolved cfrag', `Resolved (Lang_of.Path.resolved_type_fragment lang_of_map cfrag') ) | None -> Errors.report ~what:(`With_type cfrag) `Compile; (cfrag, frag) in let eqn' = type_decl_equation env (id :> Id.LabelParent.t) eqn in let ceqn' = Component.Of_Lang.(type_equation (empty ()) eqn') in Tools.fragmap env (Component.ModuleType.TypeEq (cfrag', ceqn')) sg >>= fun sg' -> Ok (sg', Odoc_model.Lang.ModuleType.TypeEq (frag', eqn')) | ModuleSubst (frag, mpath) -> let cfrag = Component.Of_Lang.(module_fragment (empty ()) frag) in let cfrag', frag' = match Tools.resolve_module_fragment env (fragment_root, sg) cfrag with | Some cfrag -> ( `Resolved cfrag, `Resolved (Lang_of.Path.resolved_module_fragment lang_of_map cfrag) ) | None -> Errors.report ~what:(`With_module cfrag) `Resolve; (cfrag, frag) in let mpath' = module_path env mpath in let cmpath' = Component.Of_Lang.(module_path (empty ()) mpath') in Tools.fragmap env (Component.ModuleType.ModuleSubst (cfrag', cmpath')) sg >>= fun sg' -> Ok (sg', Odoc_model.Lang.ModuleType.ModuleSubst (frag', mpath')) | TypeSubst (frag, eqn) -> let cfrag = Component.Of_Lang.(type_fragment (empty ()) frag) in let cfrag', frag' = match Tools.resolve_type_fragment env (fragment_root, sg) cfrag with | Some cfrag -> ( `Resolved cfrag, `Resolved (Lang_of.Path.resolved_type_fragment lang_of_map cfrag) ) | None -> Errors.report ~what:(`With_type cfrag) `Compile; (cfrag, frag) in let eqn' = type_decl_equation env (id :> Id.LabelParent.t) eqn in let ceqn' = Component.Of_Lang.(type_equation (empty ()) eqn') in Tools.fragmap env (Component.ModuleType.TypeSubst (cfrag', ceqn')) sg >>= fun sg' -> Ok (sg', Odoc_model.Lang.ModuleType.TypeSubst (frag', eqn')) | ModuleTypeEq (frag, mty) -> let cfrag = Component.Of_Lang.(module_type_fragment (empty ()) frag) in let cfrag', frag' = match Tools.resolve_module_type_fragment env (fragment_root, sg) cfrag with | Some cfrag' -> ( `Resolved cfrag', `Resolved (Lang_of.Path.resolved_module_type_fragment lang_of_map cfrag') ) | None -> Errors.report ~what:(`With_module_type cfrag) `Resolve; (cfrag, frag) in let mty = module_type_expr env id mty in let mty' = Component.Of_Lang.(module_type_expr (empty ()) mty) in let resolved_csub = Component.ModuleType.ModuleTypeEq (cfrag', mty') in Tools.fragmap env resolved_csub sg >>= fun sg' -> Ok (sg', Odoc_model.Lang.ModuleType.ModuleTypeEq (frag', mty)) | Odoc_model.Lang.ModuleType.ModuleTypeSubst (frag, mty) -> let cfrag = Component.Of_Lang.(module_type_fragment (empty ()) frag) in let cfrag', frag' = match Tools.resolve_module_type_fragment env (fragment_root, sg) cfrag with | Some cfrag' -> ( `Resolved cfrag', `Resolved (Lang_of.Path.resolved_module_type_fragment lang_of_map cfrag') ) | None -> Errors.report ~what:(`With_module_type cfrag) `Resolve; (cfrag, frag) in let mty = module_type_expr env id mty in let mty' = Component.Of_Lang.(module_type_expr (empty ()) mty) in let resolved_csub = Component.ModuleType.ModuleTypeSubst (cfrag', mty') in Tools.fragmap env resolved_csub sg >>= fun sg' -> Ok (sg', Odoc_model.Lang.ModuleType.ModuleTypeSubst (frag', mty)) in match sg_and_sub with | Ok (sg', sub') -> (Ok sg', env, sub' :: subs) | Error _ -> (sg_res, env, lsub :: subs)) and module_type_map_subs env id cexpr subs = let rec find_parent : Component.ModuleType.U.expr -> Cfrag.root option = fun expr -> match expr with | Component.ModuleType.U.Signature _ -> None | Path (`Resolved p) -> Some (`ModuleType p) | Path _ -> None | With (_, e) -> find_parent e | TypeOf (ModPath (`Resolved p), _) | TypeOf (StructInclude (`Resolved p), _) -> Some (`Module p) | TypeOf _ -> None in match find_parent cexpr with | None -> None | Some parent -> ( match Tools.signature_of_u_module_type_expr env cexpr with | Error e -> Errors.report ~what:(`Module_type id) ~tools_error:e `Lookup; None | Ok sg -> let fragment_root = match parent with (`ModuleType _ | `Module _) as x -> x in let _, _, subs = List.fold_left (module_type_expr_sub (id :> Id.Signature.t) ~fragment_root) (Ok sg, env, []) subs in let subs = List.rev subs in Some subs) and u_module_type_expr : Env.t -> Id.Signature.t -> ModuleType.U.expr -> ModuleType.U.expr = fun env id expr -> let open ModuleType in let rec inner : U.expr -> U.expr = function | Signature s -> Signature s | Path p -> Path (module_type_path env p) | With (subs, expr) -> let expr' = inner expr in let cexpr = Component.Of_Lang.(u_module_type_expr (empty ()) expr') in let subs' = match module_type_map_subs env id cexpr subs with | Some s -> s | None -> subs in let result : ModuleType.U.expr = With (subs', expr') in result | TypeOf (t_desc, t_original_path) -> let t_desc = match t_desc with | ModPath p -> ModPath (module_path env p) | StructInclude p -> StructInclude (module_path env p) in TypeOf (t_desc, t_original_path) in inner expr and module_type_expr : Env.t -> Id.Signature.t -> ?expand_paths:bool -> ModuleType.expr -> ModuleType.expr = fun env id ?(expand_paths = true) expr -> let open Odoc_utils.ResultMonad in let get_expansion cur e = match cur with | Some e -> Some (simple_expansion env id e) | None -> ( let ce = Component.Of_Lang.(module_type_expr (empty ()) e) in match Tools.expansion_of_module_type_expr env ce >>= Expand_tools.handle_expansion env id with | Ok (_, ce) -> let e = Lang_of.simple_expansion (Lang_of.empty ()) id ce in Some (simple_expansion env id e) | Error `OpaqueModule -> None | Error e -> Errors.report ~what:(`Module_type_expr ce) ~tools_error:e `Expand; None) in match expr with | Signature s -> Signature (signature env id s) | Path { p_path; p_expansion } as e -> let p_expansion = if expand_paths then get_expansion p_expansion e else p_expansion in Path { p_path = module_type_path env p_path; p_expansion } | With { w_substitutions; w_expansion; w_expr } as e -> ( let w_expansion = get_expansion w_expansion e in let rec all_withs = function | ModuleType.U.With (_, e) -> all_withs e | Signature _ -> true | _ -> false in match (all_withs w_expr, w_expansion) with | true, Some (Signature e) -> Signature e | _ -> ( let w_expr = u_module_type_expr env id w_expr in let cexpr = Component.Of_Lang.(u_module_type_expr (empty ()) w_expr) in let subs' = module_type_map_subs env id cexpr w_substitutions in match subs' with | None -> With { w_substitutions; w_expansion; w_expr } | Some s -> With { w_substitutions = s; w_expansion; w_expr })) | Functor (param, res) -> let param' = functor_parameter env param in let env' = Env.add_functor_parameter param env in let res' = module_type_expr env' (Paths.Identifier.Mk.result id) res in Functor (param', res') | TypeOf { t_desc; t_original_path; t_expansion } as e -> let t_expansion = get_expansion t_expansion e in let t_desc = match t_desc with | ModPath p -> ModuleType.ModPath (module_path env p) | StructInclude p -> StructInclude (module_path env p) in TypeOf { t_desc; t_original_path; t_expansion } and type_decl : Env.t -> TypeDecl.t -> TypeDecl.t = fun env t -> let open TypeDecl in let container = match t.id.iv with `Type (parent, _) -> (parent :> Id.LabelParent.t) in let equation = type_decl_equation env container t.equation in let representation = Opt.map (type_decl_representation env container) t.representation in { t with equation; representation } and type_decl_equation : Env.t -> Id.LabelParent.t -> TypeDecl.Equation.t -> TypeDecl.Equation.t = fun env parent t -> let open TypeDecl.Equation in let manifest = Opt.map (type_expression env parent) t.manifest in let constraints = List.map (fun (tex1, tex2) -> (type_expression env parent tex1, type_expression env parent tex2)) t.constraints in { t with manifest; constraints } and type_decl_representation : Env.t -> Id.LabelParent.t -> TypeDecl.Representation.t -> TypeDecl.Representation.t = fun env parent r -> let open TypeDecl.Representation in match r with | Variant cs -> Variant (List.map (type_decl_constructor env parent) cs) | Record fs -> Record (List.map (type_decl_field env parent) fs) | Extensible -> Extensible and type_decl_field env parent f = let open TypeDecl.Field in { f with type_ = type_expression env parent f.type_ } and type_decl_constructor_argument env parent c = let open TypeDecl.Constructor in match c with | Tuple ts -> Tuple (List.map (type_expression env parent) ts) | Record fs -> Record (List.map (type_decl_field env parent) fs) and type_decl_constructor : Env.t -> Id.LabelParent.t -> TypeDecl.Constructor.t -> TypeDecl.Constructor.t = fun env parent c -> let open TypeDecl.Constructor in let args = type_decl_constructor_argument env parent c.args in let res = Opt.map (type_expression env parent) c.res in { c with args; res } and type_expression_polyvar env parent v = let open TypeExpr.Polymorphic_variant in let constructor c = let open Constructor in { c with arguments = List.map (type_expression env parent) c.arguments } in let element = function | Type t -> Type (type_expression env parent t) | Constructor c -> Constructor (constructor c) in { v with elements = List.map element v.elements } and type_expression_object env parent o = let open TypeExpr.Object in let method_ m = { m with type_ = type_expression env parent m.type_ } in let field = function | Method m -> Method (method_ m) | Inherit t -> Inherit (type_expression env parent t) in { o with fields = List.map field o.fields } and type_expression_package env parent p = let open TypeExpr.Package in let cp = Component.Of_Lang.(module_type_path (empty ()) p.path) in match Tools.resolve_module_type env cp with | Ok (path, mt) -> ( match p.substitutions with | [] -> (* No substitutions, don't need to try to resolve them *) { path = module_type_path env p.path; substitutions = [] } | _ -> ( match Tools.expansion_of_module_type env mt with | Error e -> Errors.report ~what:(`Package cp) ~tools_error:e `Lookup; p | Ok (Functor _) -> failwith "Type expression package of functor with substitutions!" | Ok (Signature sg) -> let substitution (frag, t) = let cfrag = Component.Of_Lang.(type_fragment (empty ()) frag) in let frag' = match Tools.resolve_type_fragment env (`ModuleType path, sg) cfrag with | Some cfrag' -> `Resolved (Lang_of.(Path.resolved_type_fragment (empty ())) cfrag') | None -> Errors.report ~what:(`Type cfrag) `Compile; frag in (frag', type_expression env parent t) in { path = module_type_path env p.path; substitutions = List.map substitution p.substitutions; })) | Error _ -> { p with path = Lang_of.(Path.module_type (empty ()) cp) } and handle_arrow : Env.t -> Id.Id.label_parent -> TypeExpr.label option -> TypeExpr.t -> TypeExpr.t -> TypeExpr.t = fun env parent lbl t1 t2 -> let t2' = type_expression env parent t2 in match lbl with | Some (Optional _ | Label _) | None -> Arrow (lbl, type_expression env parent t1, t2') | Some (RawOptional s) -> ( (* s is definitely an option type, but not _obviously_ so. *) match Component.Of_Lang.(type_expression (empty ()) t1) with | Constr (p, _ts) -> ( (* This handles only the simplest case *) let find_option t = match Tools.resolve_type env t with | Ok (_, `FType (_n, decl)) -> ( match decl.equation.manifest with | Some (Constr (`Resolved (`CoreType n), [ t ])) when Names.TypeName.to_string n = "option" -> let t = Lang_of.(type_expr (empty ()) parent t) in Some t | Some _ -> None | None -> None) | Ok (_, `CoreType _) -> None | Ok (_, (`FClass _ | `FClassType _ | `FType_removed _)) -> None | Error _ -> None in match find_option p with | Some t1 -> Arrow (Some (Optional s), type_expression env parent t1, t2') | None -> Arrow (Some (RawOptional s), type_expression env parent t1, t2')) | _ -> Arrow (Some (RawOptional s), type_expression env parent t1, t2')) and type_expression : Env.t -> Id.LabelParent.t -> _ -> _ = fun env parent texpr -> let open TypeExpr in match texpr with | Var _ | Any -> texpr | Alias (t, str) -> Alias (type_expression env parent t, str) | Arrow (lbl, t1, t2) -> handle_arrow env parent lbl t1 t2 | Tuple ts -> Tuple (List.map (type_expression env parent) ts) | Constr (path, ts') -> ( let cp = Component.Of_Lang.(type_path (empty ()) path) in let ts = List.map (type_expression env parent) ts' in match Tools.resolve_type env cp with | Ok (cp, (`FType _ | `FClass _ | `FClassType _ | `CoreType _)) -> let p = Lang_of.(Path.resolved_type (empty ()) cp) in Constr (`Resolved p, ts) | Ok (_cp, `FType_removed (_, x, _eq)) -> (* Substitute type variables ? *) Lang_of.(type_expr (empty ()) parent x) | Error _e -> Constr ((Lang_of.(Path.type_ (empty ()) cp) :> Paths.Path.Type.t), ts) ) | Polymorphic_variant v -> Polymorphic_variant (type_expression_polyvar env parent v) | Object o -> Object (type_expression_object env parent o) | Class (path, ts) -> ( let ts' = List.map (type_expression env parent) ts in let cp = Component.Of_Lang.(class_type_path (empty ()) path) in match Tools.resolve_class_type env cp with | Ok (cp, (`FClass _ | `FClassType _)) -> let p = Lang_of.(Path.resolved_class_type (empty ()) cp) in Class (`Resolved p, ts') | _ -> Class (path, ts')) | Poly (strs, t) -> Poly (strs, type_expression env parent t) | Package p -> Package (type_expression_package env parent p) let compile ~filename env compilation_unit = Lookup_failures.catch_failures ~filename (fun () -> unit env compilation_unit) let compile_impl ~filename env i = Lookup_failures.catch_failures ~filename (fun () -> implementation env i) let resolve_page _resolver y = y
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>