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.commands/query_json.ml.html
Source file query_json.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
(* {{{ 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 open Query_protocol let dump (type a) : a t -> json = let mk command args = `Assoc (("command", `String command) :: args) in let mk_position = function | `Start -> `String "start" | `End -> `String "end" | `Offset n -> `Assoc [ ("offset", `Int n) ] | `Logical (line, col) -> `Assoc [ ("line", `Int line); ("column", `Int col) ] in let kinds_to_json kind = `List (List.map ~f:(function | `Constructor -> `String "constructor" | `Keywords -> `String "keywords" | `Labels -> `String "label" | `Modules -> `String "module" | `Modules_type -> `String "module-type" | `Types -> `String "type" | `Values -> `String "value" | `Variants -> `String "variant") kind) in function | Type_expr (expr, pos) -> mk "type-expression" [ ("expression", `String expr); ("position", mk_position pos) ] | Type_enclosing (opt_cursor, pos, index) -> mk "type-enclosing" [ ( "cursor", match opt_cursor with | None -> `Null | Some (text, offset) -> `Assoc [ ("text", `String text); ("offset", `Int offset) ] ); ( "index", match index with | None -> `String "all" | Some n -> `Int n ); ("position", mk_position pos) ] | Locate_type pos -> mk "locate-type" [ ("position", mk_position pos) ] | Enclosing pos -> mk "enclosing" [ ("position", mk_position pos) ] | Complete_prefix (prefix, pos, kind, doc, typ) -> mk "complete-prefix" [ ("prefix", `String prefix); ("position", mk_position pos); ("with-doc", `Bool doc); ("with-types", `Bool typ); ("kind", kinds_to_json kind) ] | Expand_prefix (prefix, pos, kind, typ) -> mk "expand-prefix" [ ("prefix", `String prefix); ("position", mk_position pos); ("with-types", `Bool typ); ("kind", kinds_to_json kind) ] | Document (identifier, pos) -> mk "document" [ ( "identifier", match identifier with | None -> `Null | Some ident -> `String ident ); ("position", mk_position pos) ] | Syntax_document pos -> mk "syntax-document" [ ("position", mk_position pos) ] | Expand_ppx pos -> mk "ppx-expand" [ ("position", mk_position pos) ] | Locate (prefix, look_for, pos) -> mk "locate" [ ( "prefix", match prefix with | None -> `Null | Some prefix -> `String prefix ); ( "look-for", match look_for with | `ML -> `String "implementation" | `MLI -> `String "interface" ); ("position", mk_position pos) ] | Jump (target, pos) -> mk "jump" [ ("target", `String target); ("position", mk_position pos) ] | Phrase (target, pos) -> mk "phrase" [ ( "target", `String (match target with | `Next -> "next" | `Prev -> "prev") ); ("position", mk_position pos) ] | Case_analysis (pos_start, pos_end) -> mk "case-analysis" [ ("start", mk_position pos_start); ("end", mk_position pos_end) ] | Holes -> mk "holes" [] | Construct (pos, with_values, depth) -> let depth = Option.value ~default:1 depth in mk "construct" [ ("position", mk_position pos); ( "with_values", match with_values with | Some `None | None -> `String "none" | Some `Local -> `String "local" ); ("depth", `Int depth) ] | Inlay_hints ( start, stop, hint_let_binding, hint_pattern_var, hint_function_params, ghost ) -> mk "inlay-hints" [ ("start", mk_position start); ("stop", mk_position stop); ("hint-let-binding", `Bool hint_let_binding); ("hint-pattern-variable", `Bool hint_pattern_var); ("hint-function-params", `Bool hint_function_params); ("avoid-ghost-location", `Bool ghost) ] | Outline -> mk "outline" [] | Errors { lexing; parsing; typing } -> let args = if lexing && parsing && typing then [] else [ ("lexing", `Bool lexing); ("parsing", `Bool parsing); ("typing", `Bool typing) ] in mk "errors" args | Shape pos -> mk "shape" [ ("position", mk_position pos) ] | Dump args -> mk "dump" [ ("args", `List args) ] | Path_of_source paths -> mk "path-of-source" [ ("paths", `List (List.map ~f:Json.string paths)) ] | List_modules exts -> mk "list-modules" [ ("extensions", `List (List.map ~f:Json.string exts)) ] | Findlib_list -> mk "findlib-list" [] | Extension_list status -> mk "extension-list" [ ( "filter", match status with | `All -> `String "all" | `Enabled -> `String "enabled" | `Disabled -> `String "disabled" ) ] | Path_list var -> mk "path-list" [ ( "variable", match var with | `Build -> `String "build" | `Source -> `String "source" ) ] | Polarity_search (query, pos) -> mk "polarity-search" [ ("query", `String query); ("position", mk_position pos) ] | Type_search (query, pos, limit, with_doc) -> mk "type-search" [ ("query", `String query); ("position", mk_position pos); ("limit", `Int limit); ("with-doc", `Bool with_doc) ] | Occurrences (`Ident_at pos, scope) -> mk "occurrences" [ ("kind", `String "identifiers"); ("position", mk_position pos); ( "scope", match scope with | `Buffer -> `String "local" | `Project -> `String "project" | `Renaming -> `String "renaming" ) ] | Refactor_open (action, pos) -> mk "refactor-open" [ ( "action", `String (match action with | `Qualify -> "qualify" | `Unqualify -> "unqualify") ); ("position", mk_position pos) ] | Signature_help { position; _ } -> mk "signature-help" [ ("position", mk_position position) ] | Version -> mk "version" [] let string_of_completion_kind = function | `Value -> "Value" | `Variant -> "Variant" | `Constructor -> "Constructor" | `Label -> "Label" | `Module -> "Module" | `Modtype -> "Signature" | `Type -> "Type" | `Method -> "Method" | `MethodCall -> "#" | `Exn -> "Exn" | `Class -> "Class" | `ClassType -> "ClassType" | `Keyword -> "Keyword" let with_location ?(with_file = false) ?(skip_none = false) loc assoc = let with_file l = if not with_file then l else ("file", `String loc.Location.loc_start.pos_fname) :: l in if skip_none && loc = Location.none then `Assoc assoc else `Assoc (with_file @@ ("start", Lexing.json_of_position loc.Location.loc_start) :: ("end", Lexing.json_of_position loc.Location.loc_end) :: assoc) let json_of_type_loc (loc, desc, tail) = with_location loc [ ( "type", match desc with | `String _ as str -> str | `Index n -> `Int n ); ( "tail", `String (match tail with | `No -> "no" | `Tail_position -> "position" | `Tail_call -> "call") ) ] let json_of_error (error : Location.error) = let of_sub loc sub = let msg = Location.print_sub_msg Format.str_formatter sub; String.trim (Format.flush_str_formatter ()) in with_location ~skip_none:true loc [ ("message", `String msg) ] in let loc = Location.loc_of_report error in let msg = Format.asprintf "@[%a@]" Location.print_main error |> String.trim in let typ = match error.source with | Location.Lexer -> "lexer" | Location.Parser -> "parser" | Location.Typer -> "typer" | Location.Warning -> if String.is_prefixed ~by:"Error" msg then "typer" (* Handle warn-error (since 4.08) *) else "warning" | Location.Unknown -> "unknown" | Location.Env -> "env" | Location.Config -> "config" in let content = [ ("type", `String typ); ("sub", `List (List.map ~f:(of_sub loc) error.sub)); ("valid", `Bool true); ("message", `String msg) ] in with_location ~skip_none:true loc content let json_of_completion { Compl.name; kind; desc; info; deprecated } = `Assoc [ ("name", `String name); ("kind", `String (string_of_completion_kind kind)); ("desc", `String desc); ("info", `String info); ("deprecated", `Bool deprecated) ] let json_of_completions { Compl.entries; context } = `Assoc [ ("entries", `List (List.map ~f:json_of_completion entries)); ( "context", match context with | `Unknown -> `Null | `Application { Compl.argument_type; labels } -> let label (name, ty) = `Assoc [ ("name", `String name); ("type", `String ty) ] in let a = `Assoc [ ("argument_type", `String argument_type); ("labels", `List (List.map ~f:label labels)) ] in `List [ `String "application"; a ] ) ] let rec json_of_outline outline = let json_of_item { outline_name; outline_kind; outline_type; location; selection; children; deprecated } = with_location location [ ("name", `String outline_name); ("kind", `String (string_of_completion_kind outline_kind)); ( "type", match outline_type with | None -> `Null | Some typ -> `String typ ); ("children", `List (json_of_outline children)); ("deprecated", `Bool deprecated); ("selection", with_location selection []) ] in List.map ~f:json_of_item outline let rec json_of_shape { shape_loc; shape_sub } = with_location shape_loc [ ("children", `List (List.map ~f:json_of_shape shape_sub)) ] let json_of_locate resp = match resp with | `At_origin -> `String "Already at definition point" | `Builtin s -> `String (sprintf "%S is a builtin, and it is therefore impossible to jump to its \ definition" s) | `Invalid_context -> `String "Not a valid identifier" | `Not_found (id, None) -> `String ("didn't manage to find " ^ id) | `Not_found (i, Some f) -> `String (sprintf "%s was supposed to be in %s but could not be found" i f) | `Not_in_env str -> `String (Printf.sprintf "Not in environment '%s'" str) | `File_not_found msg -> `String msg | `Found (None, pos) -> `Assoc [ ("pos", Lexing.json_of_position pos) ] | `Found (Some file, pos) -> `Assoc [ ("file", `String file); ("pos", Lexing.json_of_position pos) ] let json_of_inlay_hints hints = let json_of_hint (position, label) = `Assoc [ ("pos", Lexing.json_of_position position); ("label", `String label) ] in `List (List.map ~f:json_of_hint hints) let json_of_signature_help resp = let param { label_start; label_end } = `Assoc [ ("label", `List [ `Int label_start; `Int label_end ]) ] in match resp with | None -> `Assoc [] | Some { label; parameters; active_param; active_signature } -> let signature = `Assoc [ ("label", `String label); ("parameters", `List (List.map ~f:param parameters)) ] in `Assoc [ ("signatures", `List [ signature ]); ("activeParameter", `Int active_param); ("activeSignature", `Int active_signature) ] let json_of_search_result list = let list = List.map ~f:(fun { name; typ; loc; cost; doc; constructible } -> with_location ~with_file:true loc [ ("name", `String name); ("type", `String typ); ("cost", `Int cost); ( "doc", match doc with | Some x -> `String x | None -> `Null ); ("constructible", `String constructible) ]) list in `List list let json_of_response (type a) (query : a t) (response : a) : json = match (query, response) with | Type_expr _, str -> `String str | Type_enclosing _, results -> `List (List.map ~f:json_of_type_loc results) | Enclosing _, results -> `List (List.map ~f:(fun loc -> with_location loc []) results) | Complete_prefix _, compl -> json_of_completions compl | Expand_prefix _, compl -> json_of_completions compl | Polarity_search _, compl -> json_of_completions compl | Type_search _, result -> json_of_search_result result | Refactor_open _, locations -> `List (List.map locations ~f:(fun (name, loc) -> with_location loc [ ("content", `String name) ])) | Document _, resp -> begin match resp with | `No_documentation -> `String "No documentation available" | `Invalid_context -> `String "Not a valid identifier" | `Builtin s -> `String (sprintf "%S is a builtin, no documentation is available" s) | `Not_found (id, None) -> `String ("didn't manage to find " ^ id) | `Not_found (i, Some f) -> `String (sprintf "%s was supposed to be in %s but could not be found" i f) | `Not_in_env str -> `String (Printf.sprintf "Not in environment '%s'" str) | `File_not_found msg -> `String msg | `Found doc -> `String doc end | Syntax_document _, resp -> ( match resp with | `Found info -> `Assoc [ ("name", `String info.name); ("description", `String info.description); ("url", `String info.documentation) ] | `No_documentation -> `String "No documentation found") | Expand_ppx _, resp -> let str = match resp with | `Found ppx_info -> `Assoc [ ("code", `String ppx_info.code); ( "deriver", `Assoc [ ("start", Lexing.json_of_position ppx_info.attr_start); ("end", Lexing.json_of_position ppx_info.attr_end) ] ) ] | `No_ppx -> `String "No PPX deriver/extension node found on this position" in str | Locate_type _, resp -> json_of_locate resp | Locate _, resp -> json_of_locate resp | Jump _, resp -> begin match resp with | `Error str -> `String str | `Found pos -> `Assoc [ ("pos", Lexing.json_of_position pos) ] end | Phrase _, pos -> `Assoc [ ("pos", Lexing.json_of_position pos) ] | Case_analysis _, ({ Location.loc_start; loc_end; _ }, str) -> let assoc = `Assoc [ ("start", Lexing.json_of_position loc_start); ("end", Lexing.json_of_position loc_end) ] in `List [ assoc; `String str ] | Holes, locations -> `List (List.map locations ~f:(fun (loc, typ) -> with_location loc [ ("type", `String typ) ])) | Construct _, ({ Location.loc_start; loc_end; _ }, strs) -> let assoc = `Assoc [ ("start", Lexing.json_of_position loc_start); ("end", Lexing.json_of_position loc_end) ] in `List [ assoc; `List (List.map ~f:Json.string strs) ] | Outline, outlines -> `List (json_of_outline outlines) | Shape _, shapes -> `List (List.map ~f:json_of_shape shapes) | Inlay_hints _, result -> json_of_inlay_hints result | Errors _, errors -> `List (List.map ~f:json_of_error errors) | Dump _, json -> json | Path_of_source _, str -> `String str | List_modules _, strs -> `List (List.map ~f:Json.string strs) | Findlib_list, strs -> `List (List.map ~f:Json.string strs) | Extension_list _, strs -> `List (List.map ~f:Json.string strs) | Path_list _, strs -> `List (List.map ~f:Json.string strs) | Occurrences (_, scope), (occurrences, _project) -> let with_file = scope = `Project || scope = `Renaming in `List (List.map occurrences ~f:(fun occurrence -> with_location ~with_file occurrence.loc [ ("stale", Json.bool occurrence.is_stale) ])) | Signature_help _, s -> json_of_signature_help s | Version, version -> `String version
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>