Add support for OCaml 5.2

.github/workflows/main.yml

@@ -6,7 +6,7 @@ name: CI
 # events but only for the master branch
 on:
   push:
-    branches: [ '501' ]
+    branches: [ '502-preview' ]
     paths-ignore:
       - '**.md'
       - '**.txt'
@@ -16,7 +16,7 @@ on:
       - 'vim/**'
       - '**/emacs-lint.yml'
   pull_request:
-    branches: [ '501' ]
+    branches: [ '502-preview' ]
     paths-ignore:
       - '**.md'
       - '**.txt'
@@ -40,7 +40,7 @@ jobs:
           - ubuntu-latest
           # - windows-latest
         ocaml-compiler:
-          - "5.1.1"
+          - "5.2"
     # The type of runner that the job will run on
     runs-on: ${{ matrix.os }}
 

CHANGES.md

@@ -1,3 +1,10 @@
+merlin 4.14-preview
+===================
+Fri Feb 16 17:31:42 CET 2024
+
+  + merlin binary
+    - Preliminary support for OCaml 5.2
+
 merlin 4.13.1
 =============
 Fri Dec  1 15:00:42 CET 2023

dot-merlin-reader.opam

@@ -11,7 +11,7 @@ build: [
   ["dune" "build" "-p" name "-j" jobs]
 ]
 depends: [
-  "ocaml" {>= "5.1" & < "5.2" }
+  "ocaml" {>= "5.2" }
   "dune" {>= "2.9.0"}
   "merlin-lib" {>= "4.9"}
   "ocamlfind" {>= "1.6.0"}

merlin-lib.opam

@@ -10,7 +10,7 @@ build: [
   ["dune" "build" "-p" name "-j" jobs]
 ]
 depends: [
-  "ocaml" {>= "5.1.1" & < "5.2"}
+  "ocaml" {>= "5.2" & < "5.3"}
   "dune" {>= "2.9.0"}
   "csexp" {>= "1.5.1"}
   "menhir"    {dev & >= "20201216"}

merlin.opam

@@ -11,7 +11,7 @@ build: [
   ["dune" "runtest" "-p" name "-j" jobs] {with-test}
 ]
 depends: [
-  "ocaml" {>= "5.1" & < "5.2"}
+  "ocaml" {>= "5.2" & < "5.3"}
   "dune" {>= "2.9.0"}
   "merlin-lib" {= version}
   "dot-merlin-reader" {>= "4.9"}

src/analysis/ast_iterators.ml

@@ -0,0 +1,51 @@
+open Std
+open Typedtree
+
+let {Logger. log} = Logger.for_section "iterators"
+
+(* The compiler contains an iterator that aims to gather definitions but
+ignores local values like let-in expressions and local type definition. To
+provide occurrences in the active buffer we extend the compiler's iterator with
+these cases. *)
+let iter_on_defs ~uid_to_locs_tbl =
+  let log = log ~title:"iter_on_defs" in
+  let register_uid uid fragment =
+    let loc = Misc_utils.loc_of_decl ~uid fragment in
+    Option.iter loc ~f:(fun loc ->
+      Types.Uid.Tbl.add uid_to_locs_tbl uid loc)
+  in
+  let iter_decl = Cmt_format.iter_on_declarations ~f:register_uid in
+  let register_uid uid loc =
+    Types.Uid.Tbl.add uid_to_locs_tbl uid loc
+  in
+  { iter_decl with
+    expr = (fun sub ({ exp_extra; _ } as expr) ->
+      List.iter exp_extra ~f:(fun (exp_extra, _loc, _attr) ->
+        match exp_extra with
+        | Texp_newtype' (typ_id, typ_name, uid) ->
+          log "Found newtype %s wit id %a (%a)\n%!" typ_name.txt
+            Logger.fmt (Fun.flip Ident.print_with_scope typ_id)
+            Logger.fmt (fun fmt -> Location.print_loc fmt typ_name.loc);
+          register_uid uid typ_name;
+          ()
+        | _ -> ());
+      iter_decl.expr sub expr);
+  }
+
+let build_uid_to_locs_tbl ~(local_defs : Mtyper.typedtree) () =
+  let uid_to_locs_tbl : string Location.loc Types.Uid.Tbl.t =
+    Types.Uid.Tbl.create 64
+  in
+  let iter = iter_on_defs ~uid_to_locs_tbl in
+  begin match local_defs with
+  | `Interface sign ->
+    iter.signature iter sign
+  | `Implementation str ->
+    iter.structure iter str end;
+  uid_to_locs_tbl
+
+let iter_on_usages ~f (local_defs : Mtyper.typedtree) =
+  let iter = Cmt_format.iter_on_occurrences ~f in
+  begin match local_defs with
+  | `Interface signature -> iter.signature iter signature
+  | `Implementation structure -> iter.structure iter structure end

src/analysis/completion.ml

@@ -219,8 +219,8 @@ let make_candidate ~get_doc ~attrs ~exact ~prefix_path name ?loc ?path ty =
       | Some p, Some loc ->
         let namespace = (* FIXME: that's just terrible *)
           match kind with
-          | `Value -> `Vals
-          | `Type -> `Type
+          | `Value -> Shape.Sig_component_kind.Value
+          | `Type -> Type
           | _ -> assert false
         in
         begin match get_doc (`Completion_entry (namespace, p, loc)) with
@@ -280,7 +280,7 @@ let fold_sumtype_constructors ~env ~init ~f t =
       (Path.name path);
     begin match Env.find_type_descrs path env with
     | exception Not_found -> init
-    | Type_record _ | Type_abstract | Type_open -> init
+    | Type_record _ | Type_abstract _ | Type_open -> init
     | Type_variant (constrs, _) ->
       List.fold_right constrs ~init ~f
     end
@@ -650,7 +650,9 @@ let branch_complete buffer ?get_doc ?target_type ?kinds ~keywords prefix =
                 let lbls = Datarepr.labels_of_type p decl in
                 let labels = List.map lbls ~f:(fun (_,lbl) ->
                     try
-                      let _, lbl_arg, lbl_res = Ctype.instance_label false lbl in
+                      let _, lbl_arg, lbl_res =
+                        Ctype.instance_label ~fixed:false lbl
+                      in
                       begin try
                           Ctype.unify_var env ty lbl_res;
                         with _ -> ()

src/analysis/completion.mli

@@ -52,7 +52,7 @@ val map_entry : ('a -> 'b) ->
 
 val branch_complete
   :  Mconfig.t
-  -> ?get_doc:([> `Completion_entry of Namespace.t
+  -> ?get_doc:([> `Completion_entry of Env_lookup.Namespace.t
                 * Path.t * Location.t ] -> [> `Found of string ])
   -> ?target_type:Types.type_expr
   -> ?kinds:Compl.kind list

src/analysis/construct.ml

@@ -329,15 +329,23 @@ module Gen = struct
       in
       fun env label ty ->
         let open Asttypes in
+        let make_param arg_label pat =
+          {
+            Parsetree.pparam_loc = Location.none;
+            pparam_desc = Pparam_val (arg_label, None, pat)
+
+          }
+        in
+
         match label with
         | Labelled s | Optional s ->
             (* Pun for labelled arguments *)
-            Ast_helper.Pat.var ( Location.mknoloc s), s
+            make_param label (Ast_helper.Pat.var (Location.mknoloc s)), s
         | Nolabel -> begin match get_desc ty with
           | Tconstr (path, _, _) ->
             let name = uniq_name env (Path.last path) in
-            Ast_helper.Pat.var (Location.mknoloc name), name
-          | _ -> Ast_helper.Pat.any (), "_" end
+            make_param label (Ast_helper.Pat.var (Location.mknoloc name)), name
+          | _ ->  make_param label (Ast_helper.Pat.any ()), "_" end
     in
 
     let constructor env type_expr path constrs =
@@ -425,7 +433,7 @@ module Gen = struct
           (List.map labels ~f:(fun l -> l.Types.lbl_name)));
 
       let labels = List.map labels ~f:(fun ({ lbl_name; _ } as lbl) ->
-        let _, arg, res = Ctype.instance_label true lbl in
+        let _, arg, res = Ctype.instance_label ~fixed:true lbl in
         Ctype.unify env res typ ;
         let lid =
           Util.maybe_prefix env
@@ -477,21 +485,31 @@ module Gen = struct
             match def with
             | Type_variant (constrs, _) -> constructor env rtyp path constrs
             | Type_record (labels, _) -> record env rtyp path labels
-            | Type_abstract | Type_open -> []
+            | Type_abstract _ | Type_open -> []
           end
-        | Tarrow (label, tyleft, tyright, _) ->
-          let argument, name = make_arg env label tyleft in
-          let value_description = {
-              val_type = tyleft;
-              val_kind = Val_reg;
-              val_loc = Location.none;
-              val_attributes = [];
-              val_uid = Uid.mk ~current_unit:(Env.get_unit_name ());
-            }
-          in
-          let env = Env.add_value (Ident.create_local name) value_description env in
-          let exps = arrow_rhs env tyright in
-          List.map exps ~f:(Ast_helper.Exp.fun_ label None argument)
+        | Tarrow _ ->
+          let rec left_types acc env ty =
+            match get_desc ty with
+            | Tarrow (label, tyleft, tyright, _) ->
+              let arg, name = make_arg env label tyleft in
+              let value_description = {
+                  val_type = tyleft;
+                  val_kind = Val_reg;
+                  val_loc = Location.none;
+                  val_attributes = [];
+                  val_uid = Uid.mk ~current_unit:(Env.get_unit_name ());
+                }
+              in
+              let env =
+                Env.add_value (Ident.create_local name) value_description env
+              in
+              left_types (arg :: acc) env tyright
+            | _ -> List.rev acc, ty, env
+         in
+          let arguments, body_type, env = left_types [] env rtyp in
+          let exps = arrow_rhs env body_type in
+          List.map exps ~f:(fun e ->
+            Ast_helper.Exp.function_ arguments None (Pfunction_body e))
         | Ttuple types ->
           let choices = List.map types ~f:(exp_or_hole env)
             |> Util.combinations
@@ -548,7 +566,7 @@ module Gen = struct
 end
 
 let needs_parentheses e = match e.Parsetree.pexp_desc with
-  | Pexp_fun _
+  | Pexp_function _
   | Pexp_lazy _
   | Pexp_apply _
   | Pexp_variant (_, Some _)

src/analysis/context.ml

@@ -64,8 +64,16 @@ let cursor_on_longident_end
   match lid with
   | Longident.Lident _ -> true
   | _ ->
-    let end_offset = loc.loc_end.pos_cnum in
-    let cstr_name_size = String.length name in
+    let end_offset =
+      loc.loc_end.pos_cnum in
+    let cstr_name_size =
+      (* FIXME: this is britle, but lids don't have precise enough location
+         information to handle these cases correctly. *)
+      let name_lenght = String.length name in
+      if Pprintast.needs_parens name then
+        name_lenght + 2
+      else name_lenght
+    in
     let constr_pos =
       { loc.loc_end
         with pos_cnum = end_offset - cstr_name_size }
@@ -78,9 +86,9 @@ let inspect_pattern (type a) ~cursor ~lid (p : a Typedtree.general_pattern) =
                   (Printtyped.pattern 0) p);
   match p.pat_desc with
   | Tpat_any when Longident.last lid = "_" -> None
-  | Tpat_var (_, str_loc) when (Longident.last lid) = str_loc.txt ->
+  | Tpat_var (_, str_loc, _) when (Longident.last lid) = str_loc.txt ->
     None
-  | Tpat_alias (_, _, str_loc)
+  | Tpat_alias (_, _, str_loc, _)
     when (Longident.last lid) = str_loc.txt ->
     (* Assumption: if [Browse.enclosing] stopped on this node and not on the
       subpattern, then it must mean that the cursor is on the alias. *)
@@ -107,6 +115,7 @@ let inspect_expression ~cursor ~lid e : t =
     else Module_path
   | Texp_ident (p, lid_loc, _) ->
     let name = Path.last p in
+    log ~title:"inspect_context" "name is: [%s]" name;
     if name = "*type-error*" then
       (* For type_enclosing: it is enough to return Module_path here.
          - If the cursor was on the end of the lid typing should fail anyway