Specifies the object directory in module

  - Adds Module.Source.t for module yet without object
  - Remove the need to thread the obj_dir everywhere
  - Requires to convert the virtual modules to the implementation module

Signed-off-by: François Bobot <[email protected]>

Author: bobot

src/check_rules.ml

@@ -7,10 +7,13 @@ let dev_files p =
   | ".cmi" -> true
   | _ -> false
 
-let add_obj_dir sctx ~dir ~obj_dir =
+let add_obj_dir sctx ~obj_dir =
   if (Super_context.context sctx).merlin then
-    Super_context.add_alias_deps
-      sctx
-      (Build_system.Alias.check ~dir)
-      ~dyn_deps:(Build.paths_matching ~loc:Loc.none ~dir:obj_dir dev_files)
-      Path.Set.empty
+    let f dir =
+      Super_context.add_alias_deps
+        sctx
+        (Build_system.Alias.check ~dir:obj_dir.Obj_dir.dir)
+        ~dyn_deps:(Build.paths_matching ~loc:Loc.none ~dir dev_files)
+        Path.Set.empty
+    in
+    List.iter ~f (Obj_dir.all_objs_dir obj_dir)

src/check_rules.mli

@@ -1,3 +1 @@
-open Stdune
-
-val add_obj_dir : Super_context.t -> dir:Path.t -> obj_dir:Path.t -> unit
+val add_obj_dir : Super_context.t -> obj_dir:Obj_dir.t -> unit

src/compilation_context.ml

@@ -48,10 +48,8 @@ type t =
   { super_context        : Super_context.t
   ; scope                : Scope.t
   ; expander             : Expander.t
-  ; dir                  : Path.t
+  ; obj_dir              : Obj_dir.t
   ; dir_kind             : Dune_lang.Syntax.t
-  ; obj_dir              : Path.t
-  ; private_obj_dir      : Path.t option
   ; modules              : Module.t Module.Name.Map.t
   ; alias_module         : Module.t option
   ; lib_interface_module : Module.t option
@@ -68,10 +66,9 @@ type t =
 let super_context        t = t.super_context
 let scope                t = t.scope
 let expander             t = t.expander
-let dir                  t = t.dir
+let dir                  t = t.obj_dir.dir
 let dir_kind             t = t.dir_kind
 let obj_dir              t = t.obj_dir
-let private_obj_dir      t = t.private_obj_dir
 let modules              t = t.modules
 let alias_module         t = t.alias_module
 let lib_interface_module t = t.lib_interface_module
@@ -86,19 +83,17 @@ let vimpl                t = t.vimpl
 
 let context              t = Super_context.context t.super_context
 
-let create ~super_context ~scope ~expander ~dir ?private_obj_dir
+let create ~super_context ~scope ~expander ~obj_dir
       ?vimpl
       ?(dir_kind=Dune_lang.Syntax.Dune)
-      ?(obj_dir=dir) ~modules ?alias_module ?lib_interface_module ~flags
+      ~modules ?alias_module ?lib_interface_module ~flags
       ~requires ?(preprocessing=Preprocessing.dummy) ?(no_keep_locs=false)
       ~opaque ?stdlib () =
   { super_context
   ; scope
   ; expander
-  ; dir
-  ; dir_kind
   ; obj_dir
-  ; private_obj_dir
+  ; dir_kind
   ; modules
   ; alias_module
   ; lib_interface_module

src/compilation_context.mli

@@ -17,11 +17,9 @@ val create
   :  super_context         : Super_context.t
   -> scope                 : Scope.t
   -> expander              : Expander.t
-  -> dir                   : Path.t
-  -> ?private_obj_dir      : Path.t
+  -> obj_dir               : Obj_dir.t
   -> ?vimpl                : Vimpl.t
   -> ?dir_kind             : Dune_lang.Syntax.t
-  -> ?obj_dir              : Path.t
   -> modules               : Module.t Module.Name.Map.t
   -> ?alias_module         : Module.t
   -> ?lib_interface_module : Module.t
@@ -43,8 +41,7 @@ val context              : t -> Context.t
 val scope                : t -> Scope.t
 val dir                  : t -> Path.t
 val dir_kind             : t -> Dune_lang.Syntax.t
-val obj_dir              : t -> Path.t
-val private_obj_dir      : t -> Path.t option
+val obj_dir              : t -> Obj_dir.t
 val modules              : t -> Module.t Module.Name.Map.t
 val alias_module         : t -> Module.t option
 val lib_interface_module : t -> Module.t option

src/dir_contents.ml

@@ -151,19 +151,24 @@ let modules_of_files ~dir ~files =
   let impls = parse_one_set impl_files in
   let intfs = parse_one_set intf_files in
   Module.Name.Map.merge impls intfs ~f:(fun name impl intf ->
-    Some (Module.make name ~visibility:Public ?impl ?intf))
+    Some (Module.Source.make name ?impl ?intf))
 
 let build_modules_map (d : _ Dir_with_dune.t) ~modules =
   let scope = d.scope in
   let libs, exes =
     List.filter_partition_map d.data ~f:(fun stanza ->
       match (stanza : Stanza.t) with
       | Library lib ->
+        let obj_dir =
+          Obj_dir.make_local ~dir:d.ctx_dir (snd lib.name)
+            ~has_private_modules:(Option.is_some lib.private_modules)
+        in
         let { Modules_field_evaluator.
               all_modules = modules
             ; virtual_modules
             } =
           Modules_field_evaluator.eval ~modules
+            ~obj_dir
             ~buildable:lib.buildable
             ~virtual_modules:lib.virtual_modules
             ~private_modules:(
@@ -189,16 +194,20 @@ let build_modules_map (d : _ Dir_with_dune.t) ~modules =
             )
         in
         Left ( lib
-             , Lib_modules.make lib ~dir:d.ctx_dir modules ~virtual_modules
+             , Lib_modules.make lib ~obj_dir modules ~virtual_modules
                  ~main_module_name ~wrapped
              )
       | Executables exes
       | Tests { exes; _} ->
+        let obj_dir =
+          Obj_dir.make_exe ~dir:d.ctx_dir (List.hd exes.names |> snd)
+        in
         let { Modules_field_evaluator.
               all_modules = modules
             ; virtual_modules = _
             } =
           Modules_field_evaluator.eval ~modules
+            ~obj_dir
             ~buildable:exes.buildable
             ~virtual_modules:None
             ~private_modules:Ordered_set_lang.standard
@@ -404,8 +413,8 @@ let rec get sctx ~dir =
                    @\n- %a\
                    @\n- %a"
                   Module.Name.pp_quote name
-                  (Fmt.optional Path.pp) (Module.src_dir x)
-                  (Fmt.optional Path.pp) (Module.src_dir y)))
+                  (Fmt.optional Path.pp) (Module.Source.src_dir x)
+                  (Fmt.optional Path.pp) (Module.Source.src_dir y)))
         in
         build_modules_map d ~modules)
       in

src/dune_file.ml

@@ -986,6 +986,11 @@ module Library = struct
   let is_virtual t = Option.is_some t.virtual_modules
   let is_impl t = Option.is_some t.implements
 
+  let obj_dir ~dir t =
+    Obj_dir.make_local ~dir
+      ~has_private_modules:(t.private_modules <> None)
+      (snd t.name)
+
   module Main_module_name = struct
     type t = Module.Name.t option Inherited.t
   end

src/dune_file.mli

@@ -228,6 +228,7 @@ module Library : sig
   val best_name : t -> Lib_name.t
   val is_virtual : t -> bool
   val is_impl : t -> bool
+  val obj_dir : dir:Path.t -> t -> Obj_dir.t
 
   module Main_module_name : sig
     type t = Module.Name.t option Inherited.t

src/dune_package.ml

@@ -112,9 +112,10 @@ module Lib = struct
     record (
       field_o "main_module_name" Module.Name.decode >>= fun main_module_name ->
       field_o "implements" (located Lib_name.decode) >>= fun implements ->
+      field "name" Lib_name.decode >>= fun name ->
+      let dir = Path.append_local base (dir_of_name name) in
       let%map synopsis = field_o "synopsis" string
       and loc = loc
-      and name = field "name" Lib_name.decode
       and modes = field_l "modes" Mode.decode
       and kind = field "kind" Lib_kind.decode
       and archives = mode_paths "archives"
@@ -127,7 +128,7 @@ module Lib = struct
       and virtual_ = field_b "virtual"
       and sub_systems = Sub_system_info.record_parser ()
       and modules = field_o "modules" (Lib_modules.decode
-                         ~implements:(Option.is_some implements) ~dir:base)
+                         ~implements:(Option.is_some implements) ~dir)
       in
       let modes = Mode.Dict.Set.of_list modes in
       { kind
@@ -146,7 +147,7 @@ module Lib = struct
       ; main_module_name
       ; virtual_
       ; version = None
-      ; dir = Path.append_local base (dir_of_name name)
+      ; dir
       ; modules
       ; modes
       }

src/exe.ml

@@ -124,14 +124,13 @@ let link_exe
   let sctx     = CC.super_context cctx in
   let ctx      = SC.context       sctx in
   let dir      = CC.dir           cctx in
-  let obj_dir  = CC.obj_dir       cctx in
   let requires = CC.requires      cctx in
   let expander = CC.expander      cctx in
   let mode = linkage.mode in
   let exe = Path.relative dir (name ^ linkage.ext) in
   let compiler = Option.value_exn (Context.compiler ctx mode) in
   let artifacts ~ext modules =
-    List.map modules ~f:(Module.obj_file ~obj_dir ~ext)
+    List.map modules ~f:(Module.obj_file ~ext)
   in
   let modules_and_cm_files =
     Build.memoize "cm files"

src/exe_rules.ml

@@ -8,10 +8,9 @@ let executables_rules ~sctx ~dir ~dir_kind ~expander
       (exes : Dune_file.Executables.t) =
   (* Use "eobjs" rather than "objs" to avoid a potential conflict
      with a library of the same name *)
-  let obj_dir =
-    Utils.executable_object_directory ~dir (List.hd exes.names |> snd)
+  let obj_dir = Obj_dir.make_exe ~dir (List.hd exes.names |> snd)
   in
-  Check_rules.add_obj_dir sctx ~dir ~obj_dir;
+  Check_rules.add_obj_dir sctx ~obj_dir;
   let requires = Lib.Compile.requires compile_info in
   let modules =
     Dir_contents.modules_of_executables dir_contents
@@ -87,9 +86,8 @@ let executables_rules ~sctx ~dir ~dir_kind ~expander
       ~super_context:sctx
       ~expander
       ~scope
-      ~dir
-      ~dir_kind
       ~obj_dir
+      ~dir_kind
       ~modules
       ~flags
       ~requires
@@ -108,7 +106,8 @@ let executables_rules ~sctx ~dir ~dir_kind ~expander
      ~requires:(Lib.Compile.requires compile_info)
      ~flags:(Ocaml_flags.common flags)
      ~preprocess:(Dune_file.Buildable.single_preprocess exes.buildable)
-     ~objs_dirs:(Path.Set.singleton obj_dir))
+     (* only public_dir? *)
+     ~objs_dirs:(Path.Set.singleton obj_dir.Obj_dir.public_dir))
 
 let rules ~sctx ~dir ~dir_contents ~scope ~expander ~dir_kind
       (exes : Dune_file.Executables.t) =