package merlin-lib
Merlin's libraries
Install
Dune Dependency
Authors
Maintainers
Sources
merlin-5.5-503.tbz
sha256=67da3b34f2fea07678267309f61da4a2c6f08298de0dc59655b8d30fd8269af1
sha512=1fb3b5180d36aa82b82a319e15b743b802b6888f0dc67645baafdb4e18dfc23a7b90064ec9bc42f7424061cf8cde7f8839178d8a8537bf4596759f3ff4891873
doc/src/merlin-lib.query_commands/query_commands.ml.html
Source file query_commands.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
(* {{{ COPYING *( This file is part of Merlin, an helper for ocaml editors Copyright (C) 2013 - 2015 Frédéric Bour <frederic.bour(_)lakaban.net> Thomas Refis <refis.thomas(_)gmail.com> Simon Castellan <simon.castellan(_)iuwt.fr> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. The Software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software. )* }}} *) open Misc open Std open Query_protocol module Printtyp = Type_utils.Printtyp exception No_nodes let print_completion_entries ~with_types config source entries = if with_types then ( let input_ref = ref [] and output_ref = ref [] in let preprocess entry = match Completion.raw_info_printer entry with | `String s -> `String s | `Print t -> let r = ref "" in input_ref := t :: !input_ref; output_ref := r :: !output_ref; `Print r | `Concat (s, t) -> let r = ref "" in input_ref := t :: !input_ref; output_ref := r :: !output_ref; `Concat (s, r) in let entries = List.rev_map ~f:(Completion.map_entry preprocess) entries in let entries = List.rev entries in let outcomes = Mreader.print_batch_outcome config source !input_ref in List.iter2 ~f:( := ) !output_ref outcomes; let postprocess = function | `String s -> s | `Print r -> !r | `Concat (s, r) -> s ^ !r in List.rev_map ~f:(Completion.map_entry postprocess) entries) else List.rev_map ~f:(Completion.map_entry (fun _ -> "")) entries let for_completion pipeline position = let pipeline = Mpipeline.for_completion position pipeline in let typer = Mpipeline.typer_result pipeline in (pipeline, typer) let verbosity pipeline = Mconfig.((Mpipeline.final_config pipeline).query.verbosity) let dump pipeline = function | [ `String "ppxed-source" ] -> let ppf, to_string = Format.to_string () in begin match Mpipeline.ppx_parsetree pipeline with | `Interface s -> Pprintast.signature ppf s | `Implementation s -> Pprintast.structure ppf s end; Format.pp_print_newline ppf (); Format.pp_force_newline ppf (); `String (to_string ()) | [ `String "source" ] -> let ppf, to_string = Format.to_string () in begin match Mpipeline.reader_parsetree pipeline with | `Interface s -> Pprintast.signature ppf s | `Implementation s -> Pprintast.structure ppf s end; Format.pp_print_newline ppf (); Format.pp_force_newline ppf (); `String (to_string ()) | [ `String "parsetree" ] -> let ppf, to_string = Format.to_string () in begin match Mpipeline.reader_parsetree pipeline with | `Interface s -> Printast.interface ppf s | `Implementation s -> Printast.implementation ppf s end; Format.pp_print_newline ppf (); Format.pp_force_newline ppf (); `String (to_string ()) | [ `String "ppxed-parsetree" ] -> let ppf, to_string = Format.to_string () in begin match Mpipeline.ppx_parsetree pipeline with | `Interface s -> Printast.interface ppf s | `Implementation s -> Printast.implementation ppf s end; Format.pp_print_newline ppf (); Format.pp_force_newline ppf (); `String (to_string ()) | `String (("env" | "fullenv") as kind) :: opt_pos -> let typer = Mpipeline.typer_result pipeline in let kind = if kind = "env" then `Normal else `Full in let pos = match opt_pos with | [ `String "at"; jpos ] -> Some (match jpos with | `String "start" -> `Start | `String "end" -> `End | `Int offset -> `Offset offset | `Assoc props -> begin match (List.assoc "line" props, List.assoc "col" props) with | `Int line, `Int col -> `Logical (line, col) | _ -> failwith "Incorrect position" | exception Not_found -> failwith "Incorrect position" end | _ -> failwith "Incorrect position") | [] -> None | _ -> failwith "incorrect position" in let env = match pos with | None -> Mtyper.get_env typer | Some pos -> let pos = Mpipeline.get_lexing_pos pipeline pos in fst (Mbrowse.leaf_node (Mtyper.node_at typer pos)) in let sg = Browse_misc.signature_of_env ~ignore_extensions:(kind = `Normal) env in let aux item = let ppf, to_string = Format.to_string () in Printtyp.signature ppf [ item ]; `String (to_string ()) in `List (List.map ~f:aux sg) | [ `String "browse" ] -> let typer = Mpipeline.typer_result pipeline in let structure = Mbrowse.of_typedtree (Mtyper.get_typedtree typer) in Browse_misc.dump_browse (snd (Mbrowse.leaf_node structure)) | [ `String "current-level" ] -> let _typer = Mpipeline.typer_result pipeline in `Int (Ctype.get_current_level ()) | [ `String "tokens" ] -> failwith "TODO" | [ `String "flags" ] -> let prepare_flags flags = Json.list Json.string (List.concat_map flags ~f:(fun f -> f.workval)) in let user = prepare_flags Mconfig.((Mpipeline.input_config pipeline).merlin.flags_to_apply) in let applied = prepare_flags Mconfig.((Mpipeline.final_config pipeline).merlin.flags_applied) in `Assoc [ ("user", user); ("applied", applied) ] | [ `String "warnings" ] -> let _typer = Mpipeline.typer_result pipeline in Warnings.dump () (*TODO*) | [ `String "exn" ] -> let exns = Mpipeline.reader_lexer_errors pipeline @ Mpipeline.reader_parser_errors pipeline @ Mpipeline.typer_errors pipeline in `List (List.map ~f:(fun x -> `String (Printexc.to_string x)) exns) | [ `String "paths" ] -> let paths = Mconfig.build_path (Mpipeline.final_config pipeline) in `List (List.map paths ~f:(fun s -> `String s)) | [ `String "typedtree" ] -> let tree = Mpipeline.typer_result pipeline |> Mtyper.get_typedtree in let ppf, to_string = Format.to_string () in begin match tree with | `Interface s -> Printtyped.interface ppf s | `Implementation s -> Printtyped.implementation ppf s end; Format.pp_print_newline ppf (); Format.pp_force_newline ppf (); `String (to_string ()) | _ -> failwith "known dump commands: paths, exn, warnings, flags, tokens, browse, \ source, parsetree, ppxed-source, ppxed-parsetree, typedtree, \ env/fullenv (at {col:, line:})" let dispatch pipeline (type a) : a Query_protocol.t -> a = function | Type_expr (source, pos) -> let typer = Mpipeline.typer_result pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let env, _ = Mbrowse.leaf_node (Mtyper.node_at typer pos) in let ppf, to_string = Format.to_string () in let verbosity = verbosity pipeline in let context = Context.Expr in ignore (Type_utils.type_in_env ~verbosity ~context env ppf source : bool); to_string () | Type_enclosing (expro, pos, index) -> let typer = Mpipeline.typer_result pipeline in let verbosity = verbosity pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let structures = Mbrowse.enclosing pos [ Mbrowse.of_typedtree (Mtyper.get_typedtree typer) ] in let path = match structures with | [] -> [] | browse -> Browse_misc.annotate_tail_calls browse in (* Type enclosing results come from two sources: 1. the typedtree nodes aroung the cursor's position and 2. the result of reconstructing the identifier around the cursor and typing the resulting paths. Having the results from 2 is useful because ot is finer-grained than the typedtree's nodes and can provide types for modules appearing in paths. This introduces two possible sources of duplicate results: - Sometimes the typedtree nodes in 1 overlaps and we simply remove these. - The last reconstructed enclosing usually overlaps with the first typedtree node but the printed types are not always the same (generic / specialized types). Because systematically printing these types to compare them can be very expensive in the presence of large modules, we defer this deduplication to the clients. *) let enclosing_nodes = let cmp (loc1, _, _) (loc2, _, _) = Location_aux.compare loc1 loc2 in (* There might be duplicates in the list: we remove them *) Type_enclosing.from_nodes ~path |> List.dedup_adjacent ~cmp in (* Enclosings of cursor in given expression *) let exprs = Misc_utils.reconstruct_identifier pipeline pos expro in let () = Logger.log ~section:Type_enclosing.log_section ~title:"reconstruct identifier" "%a" Logger.json (fun () -> let lst = List.map exprs ~f:(fun { Location.loc; txt } -> `Assoc [ ("start", Lexing.json_of_position loc.Location.loc_start); ("end", Lexing.json_of_position loc.Location.loc_end); ("identifier", `String txt) ]) in `List lst) in let small_enclosings = Type_enclosing.from_reconstructed exprs ~nodes:structures ~cursor:pos ~verbosity in Logger.log ~section:Type_enclosing.log_section ~title:"small enclosing" "%a" Logger.fmt (fun fmt -> Format.fprintf fmt "result = [ %a ]" (Format.pp_print_list ~pp_sep:Format.pp_print_space (fun fmt (loc, _, _) -> Location.print_loc fmt loc)) small_enclosings); let all_results = List.concat [ small_enclosings; enclosing_nodes ] in let index = (* Clamp the index to [0; number_of_results[ *) let number_of_results = List.length all_results in match index with | Some index when index < 0 -> Some 0 | Some index when index >= number_of_results -> Some (number_of_results - 1) | index -> index in List.mapi all_results ~f:(fun i (loc, text, tail) -> let print = match index with | None -> true | Some index -> index = i in let ret x = (loc, x, tail) in match text with | Type_enclosing.String str -> ret (`String str) | type_info -> if print then let printed_type = Type_enclosing.print_type ~verbosity type_info in ret (`String printed_type) else ret (`Index i)) | Enclosing pos -> let typer = Mpipeline.typer_result pipeline in let structures = Mbrowse.of_typedtree (Mtyper.get_typedtree typer) in let pos = Mpipeline.get_lexing_pos pipeline pos in let mbrowse = Mbrowse.enclosing pos [ structures ] in (* We remove possible duplicates from the list*) List.fold_left mbrowse ~init:[] ~f:(fun acc node -> let loc = Mbrowse.node_loc (snd node) in match acc with | hd :: _ as acc when Location_aux.compare hd loc = 0 -> acc | _ -> loc :: acc) |> List.rev | Locate_type pos -> let typer = Mpipeline.typer_result pipeline in let local_defs = Mtyper.get_typedtree typer in let structures = Mbrowse.of_typedtree local_defs in let pos = Mpipeline.get_lexing_pos pipeline pos in let node = match Mbrowse.enclosing pos [ structures ] with | path :: _ -> Some path | [] -> None in let path = Option.bind node ~f:(fun (env, node) -> Locate.log ~title:"query_commands Locate_type" "inspecting node: %s" (Browse_raw.string_of_node node); match node with | Browse_raw.Expression { exp_type = ty; _ } | Pattern { pat_type = ty; _ } | Core_type { ctyp_type = ty; _ } | Value_description { val_desc = { ctyp_type = ty; _ }; _ } -> begin match Types.get_desc ty with | Tconstr (path, _, _) -> Some (env, path) | _ -> None end | _ -> None) in begin match path with | None -> `Invalid_context | Some (env, path) -> ( Locate.log ~title:"debug" "found type: %s" (Path.name path); let config = Locate. { mconfig = Mpipeline.final_config pipeline; ml_or_mli = `MLI; traverse_aliases = true } in match Locate.from_path ~config ~env ~local_defs ~namespace:Type path with | `Builtin (_, s) -> `Builtin s | `Not_in_env _ as s -> s | `Not_found _ as s -> s | `Found { file; location; _ } -> `Found (Some file, location.loc_start) | `File_not_found { file = reason; _ } -> `File_not_found reason) end | Complete_prefix (prefix, pos, kinds, with_doc, with_types) -> let pipeline, typer = for_completion pipeline pos in let config = Mpipeline.final_config pipeline in let verbosity = Mconfig.(config.query.verbosity) in let no_labels = Mpipeline.reader_no_labels_for_completion pipeline in let source = Mpipeline.input_source pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let branch = Mtyper.node_at ~skip_recovered:true typer pos in let env, _ = Mbrowse.leaf_node branch in let target_type, context = Completion.application_context ~prefix branch in let get_doc = if not with_doc then None else let local_defs = Mtyper.get_typedtree typer in Some (Locate.get_doc ~config ~env ~local_defs ~comments:(Mpipeline.reader_comments pipeline) ~pos) in let keywords = Mpipeline.reader_lexer_keywords pipeline in let entries = Printtyp.wrap_printing_env env ~verbosity @@ fun () -> Completion.branch_complete config ~kinds ?get_doc ?target_type ~keywords prefix branch |> print_completion_entries ~with_types config source and context = match context with | `Application context when no_labels -> `Application { context with Compl.labels = [] } | context -> context in { Compl.entries; context } | Expand_prefix (prefix, pos, kinds, with_types) -> let pipeline, typer = for_completion pipeline pos in let source = Mpipeline.input_source pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let env, _ = Mbrowse.leaf_node (Mtyper.node_at typer pos) in let config = Mpipeline.final_config pipeline in let global_modules = Mconfig.global_modules config in let entries = Completion.expand_prefix env ~global_modules ~kinds prefix |> print_completion_entries ~with_types config source in { Compl.entries; context = `Unknown } | Polarity_search (query, pos) -> let typer = Mpipeline.typer_result pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let env, _ = Mbrowse.leaf_node (Mtyper.node_at typer pos) in let query = Polarity_search.prepare_query env query in let config = Mpipeline.final_config pipeline in let global_modules = Mconfig.global_modules config in let dirs = Polarity_search.directories ~global_modules env in ignore (Format.flush_str_formatter ()); let entries = Polarity_search.execute_query query env dirs |> List.sort ~cmp:compare |> Printtyp.wrap_printing_env env ~verbosity:(verbosity pipeline) @@ fun () -> List.map ~f:(fun (_, path, v) -> Printtyp.path Format.str_formatter path; let name = Format.flush_str_formatter () in Printtyp.type_scheme env Format.str_formatter v.Types.val_type; let desc = Format.flush_str_formatter () in { Compl.name; kind = `Value; desc; info = ""; deprecated = false }) in { Compl.entries; context = `Unknown } | Type_search (query, pos, limit, with_doc) -> let typer = Mpipeline.typer_result pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let node = Mtyper.node_at typer pos in let env, _ = Mbrowse.leaf_node node in let config = Mpipeline.final_config pipeline in let modules = Mconfig.global_modules config in let verbosity = verbosity pipeline in let results = match Type_search.classify_query query with | `By_type query -> let query = Merlin_sherlodoc.Query.from_string query in Type_search.run ~limit ~env ~query ~modules () | `Polarity query -> let query = Polarity_search.prepare_query env query in let modules = Polarity_search.directories ~global_modules:modules env in Polarity_search.execute_query_as_type_search ~limit ~env ~query ~modules () in List.map results ~f:(fun ({ name; typ; doc; _ } as v) -> let typ = Printtyp.wrap_printing_env ~verbosity env @@ fun () -> Format.asprintf "%a" (Type_utils.Printtyp.type_scheme env) typ in let doc = if not with_doc then doc else let comments = Mpipeline.reader_comments pipeline in let local_defs = Mtyper.get_typedtree typer in Type_search.get_doc ~config ~env ~local_defs ~comments ~pos name in { v with typ; doc }) | Refactor_open (mode, pos) -> let typer = Mpipeline.typer_result pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in Refactor_open.get_rewrites ~mode typer pos | Document (patho, pos) -> let typer = Mpipeline.typer_result pipeline in let local_defs = Mtyper.get_typedtree typer in let config = Mpipeline.final_config pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let comments = Mpipeline.reader_comments pipeline in let env, _ = Mbrowse.leaf_node (Mtyper.node_at typer pos) in let path = match patho with | Some p -> p | None -> let path = Misc_utils.reconstruct_identifier pipeline pos None in let path = Mreader_lexer.identifier_suffix path in let path = List.map ~f:(fun { Location.txt; _ } -> txt) path in String.concat ~sep:"." path in if path = "" then `Invalid_context else Locate.get_doc ~config ~env ~local_defs ~comments ~pos (`User_input path) | Syntax_document pos -> ( let typer = Mpipeline.typer_result pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let node = Mtyper.node_at typer pos in let res = Syntax_doc.get_syntax_doc pos node in match res with | Some res -> `Found res | None -> `No_documentation) | Expand_ppx pos -> ( let pos = Mpipeline.get_lexing_pos pipeline pos in let parsetree = Mpipeline.reader_parsetree pipeline in let ppxed_parsetree = Mpipeline.ppx_parsetree pipeline in let ppx_kind_with_attr = Ppx_expand.check_extension ~parsetree ~pos in match ppx_kind_with_attr with | Some _ -> `Found (Ppx_expand.get_ppxed_source ~ppxed_parsetree ~pos (Option.get ppx_kind_with_attr)) | None -> `No_ppx) | Locate (patho, ml_or_mli, pos) -> let typer = Mpipeline.typer_result pipeline in let local_defs = Mtyper.get_typedtree typer in let pos = Mpipeline.get_lexing_pos pipeline pos in let env, _ = Mbrowse.leaf_node (Mtyper.node_at typer pos) in let path = match patho with | Some p -> p | None -> let path = Misc_utils.reconstruct_identifier pipeline pos None in let path = Mreader_lexer.identifier_suffix path in let path = List.map ~f:(fun { Location.txt; _ } -> txt) path in let path = String.concat ~sep:"." path in Locate.log ~title:"reconstructed identifier" "%s" path; path in if path = "" then `Invalid_context else let ml_or_mli = match ml_or_mli with | `ML -> `Smart | `MLI -> `MLI in let config = Locate. { mconfig = Mpipeline.final_config pipeline; ml_or_mli; traverse_aliases = true } in begin match Locate.from_string ~config ~env ~local_defs ~pos path with | `Found { file; location; _ } -> Locate.log ~title:"result" "found: %s" file; `Found (Some file, location.loc_start) | `Missing_labels_namespace -> (* Can't happen because we haven't passed a namespace as input. *) assert false | `Builtin (_, s) -> Locate.log ~title:"result" "found builtin %s" s; `Builtin s | `File_not_found { file = reason; _ } -> `File_not_found reason | (`Not_found _ | `At_origin | `Not_in_env _) as otherwise -> Locate.log ~title:"result" "not found"; otherwise end | Jump (target, pos) -> let typer = Mpipeline.typer_result pipeline in let typedtree = Mtyper.get_typedtree typer in let pos = Mpipeline.get_lexing_pos pipeline pos in Jump.get typedtree pos target | Phrase (target, pos) -> let typer = Mpipeline.typer_result pipeline in let typedtree = Mtyper.get_typedtree typer in let pos = Mpipeline.get_lexing_pos pipeline pos in Mpipeline.get_lexing_pos pipeline (Jump.phrase typedtree pos target) | Case_analysis (pos_start, pos_end) -> let typer = Mpipeline.typer_result pipeline in let pos_start = Mpipeline.get_lexing_pos pipeline pos_start in let pos_end = Mpipeline.get_lexing_pos pipeline pos_end in let browse = Mbrowse.of_typedtree (Mtyper.get_typedtree typer) in let nodes = Mbrowse.enclosing pos_start [ browse ] in let dump_node (_, node) = let { Location.loc_start; loc_end; _ } = Mbrowse.node_loc node in let l1, c1 = Lexing.split_pos loc_start in let l2, c2 = Lexing.split_pos loc_end in `List [ `String (Browse_raw.string_of_node node); `Int l1; `Int c1; `Int l2; `Int c2 ] in Destruct.log ~title:"nodes before" "%a" Logger.json (fun () -> `List (List.map nodes ~f:dump_node)); let nodes = (* Drop nodes that: - start inside the user's selection - finish inside the user's selection *) List.drop_while nodes ~f:(fun (_, t) -> let { Location.loc_start; loc_end; _ } = Mbrowse.node_loc t in Lexing.compare_pos loc_start pos_start > 0 || Lexing.compare_pos loc_end pos_end < 0) in Destruct.log ~title:"nodes after" "%a" Logger.json (fun () -> `List (List.map nodes ~f:dump_node)); begin match nodes with | [] -> raise Destruct.Nothing_to_do | (env, node) :: parents -> let source = Mpipeline.input_source pipeline in let config = Mpipeline.final_config pipeline in let verbosity = verbosity pipeline in Printtyp.wrap_printing_env env ~verbosity @@ fun () -> Destruct.node config source node (List.map ~f:snd parents) end | Holes -> let typer = Mpipeline.typer_result pipeline in let verbosity = verbosity pipeline in let nodes = Mbrowse.of_typedtree (Mtyper.get_typedtree typer) in let ppf = Format.str_formatter in let print ~nodes loc env type_ () = match type_ with | `Exp type_expr -> Type_utils.print_type_with_decl ~verbosity env ppf type_expr | `Mod module_type -> ( (* For module_expr holes we need the type of the next enclosing to get a useful result *) match Mbrowse.enclosing loc.Location.loc_start [ nodes ] with | _ :: (_, Browse_raw.Module_expr { mod_type; _ }) :: _ -> Printtyp.modtype env ppf mod_type | _ -> Printtyp.modtype env ppf module_type) in let loc_and_types_of_holes node = List.map (Browse_raw.all_holes node) ~f:(fun (loc, env, type_) -> Printtyp.wrap_printing_env env ~verbosity (print ~nodes loc env type_); (loc, Format.flush_str_formatter ())) in List.concat_map ~f:loc_and_types_of_holes nodes | Construct (pos, with_values, depth) -> let values_scope = match with_values with | Some `None | None -> Construct.Null | Some `Local -> Construct.Local in let config = Mpipeline.final_config pipeline in let keywords = Mpipeline.reader_lexer_keywords pipeline in let typer = Mpipeline.typer_result pipeline in let typedtree = Mtyper.get_typedtree typer in let pos = Mpipeline.get_lexing_pos pipeline pos in let structures = Mbrowse.enclosing pos [ Mbrowse.of_typedtree typedtree ] in begin match structures with | ( _, (Browse_raw.Module_expr { mod_desc = Tmod_typed_hole; _ } as node_for_loc) ) :: (_, node) :: _parents -> let loc = Mbrowse.node_loc node_for_loc in (loc, Construct.node ~config ~keywords ?depth ~values_scope node) | (_, (Browse_raw.Expression { exp_desc = Texp_typed_hole; _ } as node)) :: _parents -> let loc = Mbrowse.node_loc node in (loc, Construct.node ~config ~keywords ?depth ~values_scope node) | _ :: _ -> raise Construct.Not_a_hole | [] -> raise No_nodes end | Outline -> let typer = Mpipeline.typer_result pipeline in let browse = Mbrowse.of_typedtree (Mtyper.get_typedtree typer) in Outline.get [ Browse_tree.of_browse browse ] | Shape pos -> let typer = Mpipeline.typer_result pipeline in let browse = Mbrowse.of_typedtree (Mtyper.get_typedtree typer) in let pos = Mpipeline.get_lexing_pos pipeline pos in Outline.shape pos [ Browse_tree.of_browse browse ] | Errors { lexing; parsing; typing } -> let typer = Mpipeline.typer_result pipeline in let verbosity = verbosity pipeline in let lexer_errors = Mpipeline.reader_lexer_errors pipeline in let parser_errors = Mpipeline.reader_parser_errors pipeline in let typer_errors = Mpipeline.typer_errors pipeline in Printtyp.wrap_printing_env (Mtyper.get_env typer) ~verbosity @@ fun () -> (* When there is a cmi error, we will have a lot of meaningless errors, there is no need to report them. *) let typer_errors = let cmi_error = function | Magic_numbers.Cmi.Error _ -> true | _ -> false in match List.find typer_errors ~f:cmi_error with | e -> [ e ] | exception Not_found -> typer_errors in let error_start e = (Location.loc_of_report e).Location.loc_start in let error_end e = (Location.loc_of_report e).Location.loc_end in (* Turn into Location.error, ignore ghost warnings *) let filter_error exn = match Location.error_of_exn exn with | None | Some `Already_displayed -> None | Some (`Ok (err : Location.error)) -> if (Location.loc_of_report err).loc_ghost && match exn with | Msupport.Warning _ -> true | _ -> false then None else Some err in let lexer_errors = List.filter_map ~f:filter_error lexer_errors in (* Ast can contain syntax error *) let first_syntax_error = ref Lexing.dummy_pos in let filter_typer_error exn = let result = filter_error exn in begin match result with | Some ({ Location.source = Location.Parser; _ } as err) when !first_syntax_error = Lexing.dummy_pos || Lexing.compare_pos !first_syntax_error (error_start err) > 0 -> first_syntax_error := error_start err | _ -> () end; result in let typer_errors = List.filter_map ~f:filter_typer_error typer_errors in (* Track first parsing error *) let filter_parser_error = function | Msupport.Warning _ as exn -> filter_error exn | exn -> let result = filter_error exn in begin match result with | None -> () | Some err -> if !first_syntax_error = Lexing.dummy_pos || Lexing.compare_pos !first_syntax_error (error_start err) > 0 then first_syntax_error := error_start err end; result in let parser_errors = List.filter_map ~f:filter_parser_error parser_errors in (* Sort errors *) let cmp e1 e2 = let n = Lexing.compare_pos (error_start e1) (error_start e2) in if n <> 0 then n else Lexing.compare_pos (error_end e1) (error_end e2) in let errors = List.sort_uniq ~cmp ((if lexing then lexer_errors else []) @ (if parsing then parser_errors else []) @ if typing then typer_errors else []) in (* Add configuration errors *) let errors = let cfg = Mpipeline.final_config pipeline in let failures = List.map ~f:(Location.error ~source:Location.Config) cfg.merlin.failures in failures @ errors in (* Filter anything after first parse error *) let limit = !first_syntax_error in if limit = Lexing.dummy_pos then errors else List.take_while errors ~f:(fun err -> Lexing.compare_pos (error_start err) limit <= 0) | Dump args -> dump pipeline args | Path_of_source xs -> let config = Mpipeline.final_config pipeline in let rec aux = function | [] -> raise Not_found | x :: xs -> ( try find_in_path_normalized (Mconfig.source_path config) x with Not_found -> ( try find_in_path_normalized (Mconfig.build_path config) x with Not_found -> aux xs)) in aux xs | List_modules exts -> let config = Mpipeline.final_config pipeline in let with_ext ext = modules_in_path ~ext Mconfig.(config.merlin.source_path) in List.concat_map ~f:with_ext exts | Findlib_list -> [] | Extension_list kind -> let config = Mpipeline.final_config pipeline in let enabled = Mconfig.(config.merlin.extensions) in begin match kind with | `All -> Extension.all | `Enabled -> enabled | `Disabled -> List.fold_left ~f:(fun exts ext -> List.remove ext exts) ~init:Extension.all enabled end | Path_list `Build -> let config = Mpipeline.final_config pipeline in Mconfig.(config.merlin.build_path @ config.merlin.hidden_build_path) | Path_list `Source -> let config = Mpipeline.final_config pipeline in Mconfig.(config.merlin.source_path @ config.merlin.hidden_source_path) | Occurrences (`Ident_at pos, scope) -> let config = Mpipeline.final_config pipeline in let typer_result = Mpipeline.typer_result pipeline in let pos = Mpipeline.get_lexing_pos pipeline pos in let env, _node = Mbrowse.leaf_node (Mtyper.node_at typer_result pos) in let path = let path = Misc_utils.reconstruct_identifier pipeline pos None in let path = Mreader_lexer.identifier_suffix path in let path = List.map ~f:(fun { Location.txt; _ } -> txt) path in let path = String.concat ~sep:"." path in Locate.log ~title:"reconstructed identifier" "%s" path; path in let { Occurrences.occurrences; status } = Occurrences.locs_of ~config ~env ~typer_result ~pos ~scope path in (occurrences, status) | Inlay_hints ( start, stop, hint_let_binding, hint_pattern_binding, hint_function_params, avoid_ghost_location ) -> let start = Mpipeline.get_lexing_pos pipeline start and stop = Mpipeline.get_lexing_pos pipeline stop in let typer_result = Mpipeline.typer_result pipeline in begin match Mtyper.get_typedtree typer_result with | `Interface _ -> [] | `Implementation structure -> Inlay_hints.of_structure ~hint_let_binding ~hint_pattern_binding ~hint_function_params ~avoid_ghost_location ~start ~stop structure end | Signature_help { position; _ } -> ( (* Todo: additionnal contextual information could help us provide better results.*) let typer = Mpipeline.typer_result pipeline in let pos = Mpipeline.get_lexing_pos pipeline position in let node = Mtyper.node_at typer pos in let source = Mpipeline.input_source pipeline in let prefix = Signature_help.prefix_of_position ~short_path:true source position in let application_signature = Signature_help.application_signature ~prefix ~cursor:pos node in let param offset (p : Signature_help.parameter_info) = { label_start = offset + p.param_start; label_end = offset + p.param_end } in match application_signature with | Some s -> let prefix = let fun_name = Option.value ~default:"_" s.function_name in sprintf "%s : " fun_name in Some { label = prefix ^ s.signature; parameters = List.map ~f:(param (String.length prefix)) s.parameters; active_param = Option.value ~default:0 s.active_param; active_signature = 0 } | None -> None) | Version -> Printf.sprintf "The Merlin toolkit version %s, for Ocaml %s\n" Merlin_config.version Sys.ocaml_version
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>