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.analysis/type_utils.ml.html
Source file type_utils.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
(* {{{ 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 Std let log_section = "type-utils" let { Logger.log } = Logger.for_section log_section module Verbosity = Mconfig.Verbosity let protect expr = Pprintast.ident_of_name Format.str_formatter expr; Format.flush_str_formatter () let parse_expr ?(keywords = Lexer_raw.keywords []) expr = let lexbuf = Lexing.from_string expr in let state = Lexer_raw.make keywords in let rec lexer = function | Lexer_raw.Fail (e, l) -> raise (Lexer_raw.Error (e, l)) | Lexer_raw.Return token -> token | Lexer_raw.Refill k -> lexer (k ()) in let lexer lexbuf = lexer (Lexer_raw.token_without_comments state lexbuf) in Parser_raw.parse_expression lexer lexbuf let parse_longident lid = let protected_lid = protect lid in let lexbuf = Lexing.from_string protected_lid in let state = Lexer_raw.make @@ Lexer_raw.keywords [] in let rec lexer = function | Lexer_raw.Fail (e, l) -> raise (Lexer_raw.Error (e, l)) | Lexer_raw.Return token -> token | Lexer_raw.Refill k -> lexer (k ()) in let lexer lexbuf = lexer (Lexer_raw.token_without_comments state lexbuf) in try Some (Parser_raw.parse_any_longident lexer lexbuf) with Parser_raw.Error -> None let lookup_module name env = let path, md = Env.find_module_by_name name env in (path, md.Types.md_type, md.Types.md_attributes) let verbosity = ref Verbosity.default module Printtyp = struct include Printtyp let expand_type env ty = Env.with_cmis @@ fun () -> (* ?? Not sure *) match !verbosity with | Smart | Lvl 0 -> ty | Lvl (_ : int) -> (* Fresh copy of the type to mutilate *) let ty = Subst.type_expr Subst.identity ty in let marks = Hashtbl.create 7 in let mark ty = if Hashtbl.mem marks (Types.get_id ty) then false else ( Hashtbl.add marks (Types.get_id ty) (); true) in let rec iter d ty0 = if mark ty0 then let open Types in let ty' = Ctype.full_expand ~may_forget_scope:true env ty0 in if get_desc ty' == get_desc ty0 then Btype.iter_type_expr (iter d) ty0 else begin let desc = match get_desc ty' with | Tvariant row -> Tvariant (set_row_name row None) | Tobject (ty, _) -> Tobject (ty, ref None) | desc -> desc in Types.Transient_expr.(set_desc (repr ty0) desc); if d > 0 then Btype.iter_type_expr (iter (pred d)) ty0 end in iter (match !verbosity with | Smart -> assert false | Lvl v -> v) ty; ty let expand_type_decl env ty = match ty.Types.type_manifest with | Some m -> { ty with Types.type_manifest = Some (expand_type env m) } | None -> ty let expand_sig env mty = Env.with_cmis @@ fun () -> Env.scrape_alias env mty let verbose_type_scheme env ppf t = let t = expand_type env t in Printtyp.type_scheme ppf t let verbose_type_declaration env id ppf t = Printtyp.type_declaration id ppf (expand_type_decl env t) let verbose_modtype env ppf t = Printtyp.modtype ppf (expand_sig env t) let select_by_verbosity ~default ?(smart = default) ~verbose = match !verbosity with | Smart -> smart | Lvl 0 -> default | Lvl _ -> verbose let type_scheme env ppf ty = (select_by_verbosity ~default:type_scheme ~verbose:(verbose_type_scheme env)) ppf ty let tree_of_typ_scheme te = Out_type.prepare_for_printing [ te ]; Out_type.tree_of_typexp Type_scheme te let type_declaration env id ppf = (select_by_verbosity ~default:type_declaration ~verbose:(verbose_type_declaration env)) id ppf let modtype env ppf mty = let smart ppf = function | Types.Mty_ident _ | Mty_alias _ -> verbose_modtype env ppf mty | _ -> modtype ppf mty in (select_by_verbosity ~default:modtype ~verbose:(verbose_modtype env) ~smart) ppf mty let wrap_printing_env env ~verbosity:v f = let_ref verbosity v (fun () -> wrap_printing_env ~error:true env f) end let si_modtype_opt = function | Types.Sig_modtype (_, m, _) -> m.mtd_type | Types.Sig_module (_, _, m, _, _) -> Some m.md_type | _ -> None (* Check if module is smaller (= has less definition, counting nested ones) * than a particular threshold. Return (Some n) if module has size n, or None * otherwise (module is bigger than threshold). * Used to skip printing big modules in completion. *) let rec mod_smallerthan n m = if n < 0 then None else let open Types in match m with | Mty_ident _ -> Some 1 | Mty_signature s -> begin match List.length_lessthan n s with | None -> None | Some _ -> List.fold_left s ~init:(Some 0) ~f: begin fun acc item -> let sub n1 m = match mod_smallerthan (n - n1) m with | Some n2 -> Some (n1 + n2) | None -> None in match (acc, si_modtype_opt item) with | None, _ -> None | Some n', _ when n' > n -> None | Some n1, Some mty -> sub n1 mty | Some n', _ -> Some (succ n') end end | Mty_functor _ -> let m1, m2 = unpack_functor m in begin match (mod_smallerthan n m2, m1) with | None, _ -> None | result, Unit -> result | Some n1, Named (_, mt) -> ( match mod_smallerthan (n - n1) mt with | None -> None | Some n2 -> Some (n1 + n2)) end | _ -> Some 1 let print_short_modtype verbosity env ppf md = (* In smart mode we list modules' contents, so [for_smart = 1] here *) let verbosity = Verbosity.to_int verbosity ~for_smart:1 in match mod_smallerthan 1000 md with | None when verbosity = 0 -> Format.pp_print_string ppf "(* large signature, repeat to confirm *)" | _ -> Printtyp.modtype env ppf md let print_type_with_decl ~verbosity env ppf typ = match verbosity with | Verbosity.Smart | Lvl 0 -> Printtyp.type_scheme env ppf typ | Lvl _ -> begin match Types.get_desc typ with | Types.Tconstr (path, params, _) -> let decl = Env.with_cmis @@ fun () -> Env.find_type path env in let is_abstract = match decl.Types.type_kind with | Types.Type_abstract _ -> true | _ -> false in (* Print expression only if it is parameterized or abstract *) let print_expr = is_abstract || params <> [] in if print_expr then Printtyp.type_scheme env ppf typ; (* If not abstract, also print the declaration *) if not is_abstract then begin (* Separator if expression was printed *) if print_expr then begin Format.pp_print_newline ppf (); Format.pp_print_newline ppf () end; let ident = match path with | Path.Papply _ -> assert false | Path.Pident ident -> ident | Path.Pdot _ | Path.Pextra_ty _ -> Ident.create_persistent (Path.last path) in Printtyp.type_declaration env ident ppf decl end | _ -> Printtyp.type_scheme env ppf typ end let print_exn ppf exn = match Location.error_of_exn exn with | None | Some `Already_displayed -> Format.pp_print_string ppf (Printexc.to_string exn) | Some (`Ok report) -> Location.print_main ppf report let print_type ppf env lid = let p, t = Env.find_type_by_name lid.Asttypes.txt env in match t.type_manifest with | None -> Printtyp.type_declaration env (Ident.create_persistent (* Incorrect, but doesn't matter. *) (Path.last p)) ppf t | Some type_expr -> Printtyp.type_expr ppf type_expr let print_modtype ppf verbosity env lid = let _p, mtd = Env.find_modtype_by_name lid.Asttypes.txt env in match mtd.mtd_type with | Some mt -> print_short_modtype verbosity env ppf mt | None -> Format.pp_print_string ppf "(* abstract module *)" let print_modpath ppf verbosity env lid = let _path, md = Env.find_module_by_name lid.Asttypes.txt env in print_short_modtype verbosity env ppf md.md_type let print_cstr_desc ppf cstr_desc = !Oprint.out_type ppf (Browse_misc.print_constructor cstr_desc) let print_constr ppf env lid = let cstr_desc = Env.find_constructor_by_name lid.Asttypes.txt env in (* FIXME: support Reader printer *) (Format_doc.compat print_cstr_desc) ppf cstr_desc exception Fallback let type_in_env ?(verbosity = Verbosity.default) ?keywords ~context env ppf expr = let print_expr expression = let str, _sg, _shape, _ = Env.with_cmis @@ fun () -> Typemod.type_toplevel_phrase env [ Ast_helper.Str.eval expression ] in let open Typedtree in match str.str_items with | [ { str_desc = Tstr_eval (exp, _); _ } ] -> print_type_with_decl ~verbosity env ppf exp.exp_type | _ -> failwith "unhandled expression" in Printtyp.wrap_printing_env env ~verbosity @@ fun () -> Msupport.uncatch_errors @@ fun () -> match parse_expr ?keywords @@ protect expr with | exception exn -> print_exn ppf exn; false | e -> ( let extract_specific_parsing_info e = match e.Parsetree.pexp_desc with | Parsetree.Pexp_ident longident -> `Ident longident | Parsetree.Pexp_construct (longident, _) -> `Constr longident | _ -> `Other in let open Context in match extract_specific_parsing_info e with | `Ident longident | `Constr longident -> begin try begin match context with | Label lbl_des -> (* We use information from the context because `Env.find_label_by_name` can fail *) Printtyp.type_expr ppf lbl_des.lbl_arg | Type -> log ~title:"type_in_env" "Type type"; print_type ppf env longident (* TODO: special processing for module aliases ? *) | Module_type -> print_modtype ppf verbosity env longident | Module_path -> print_modpath ppf verbosity env longident | Constructor _ -> print_constr ppf env longident | _ -> raise Fallback end; true with _ -> ( (* Fallback to contextless typing attempts *) try print_expr e; true with exn -> ( try print_modpath ppf verbosity env longident; true with _ -> ( try (* TODO: useless according to test suite *) print_modtype ppf verbosity env longident; true with _ -> ( try (* TODO: useless according to test suite *) print_constr ppf env longident; true with _ -> print_exn ppf exn; false)))) end | `Other -> ( try print_expr e; true with exn -> print_exn ppf exn; false)) let print_constr ~verbosity env ppf cd = Printtyp.wrap_printing_env env ~verbosity @@ fun () -> (Format_doc.compat print_cstr_desc) ppf cd (* From doc-ock https://github.com/lpw25/doc-ock/blob/master/src/docOckAttrs.ml *) let read_doc_attributes attrs = let rec loop = function | ({ Location.txt = "doc" | "ocaml.doc"; loc = _ }, payload) :: _ -> Ast_helper.extract_str_payload payload | _ :: rest -> loop rest | [] -> None in loop (List.map ~f:Ast_helper.Attr.as_tuple attrs) let is_deprecated = List.exists ~f:(fun (attr : Parsetree.attribute) -> match Ast_helper.Attr.as_tuple attr with | { Location.txt = "deprecated" | "ocaml.deprecated"; loc = _ }, _ -> true | _ -> false)
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>