Rename 'Packages.pkgdir' to 'pkgname'

The previous name didn't convey that this value was used to identify a
package, the new name is slightly clearer.

The type is rewritten as a record to make the two values even more
locked together.

Author: Julow

src/driver/compile.ml

@@ -17,7 +17,7 @@ type compiled = {
   include_dirs : Fpath.Set.t;
   impl : impl option;
   pkg_args : pkg_args;
-  pkgdir : Packages.pkgdir;
+  pkgname : Packages.pkgname;
 }
 
 let mk_byhash (pkgs : Packages.t Util.StringMap.t) =
@@ -197,7 +197,7 @@ let compile ?partial ~output_dir ?linked_dir all =
             include_dirs = includes;
             impl;
             pkg_args;
-            pkgdir = modty.m_pkg;
+            pkgname = modty.m_pkgname;
           }
   in
 
@@ -225,7 +225,7 @@ let compile ?partial ~output_dir ?linked_dir all =
     Util.StringMap.fold
       (fun _pkgname (pkg : Packages.t) acc ->
         Logs.debug (fun m ->
-            m "Package %s mlds: [%a]" pkg.name
+            m "Package %s mlds: [%a]" pkg.pkgname.p_name
               Fmt.(list ~sep:sp Packages.pp_mld)
               pkg.mlds);
         List.fold_left
@@ -252,7 +252,7 @@ let compile ?partial ~output_dir ?linked_dir all =
               include_dirs;
               impl = None;
               pkg_args;
-              pkgdir = mld.mld_pkg;
+              pkgname = mld.mld_pkgname;
             }
             :: acc)
           acc pkg.mlds)
@@ -267,7 +267,7 @@ let compile ?partial ~output_dir ?linked_dir all =
 type linked = {
   output_file : Fpath.t;
   src : Fpath.t option;
-  pkgdir : Packages.pkgdir;
+  pkgname : Packages.pkgname;
 }
 
 let link : compiled list -> _ =
@@ -276,9 +276,9 @@ let link : compiled list -> _ =
    fun c ->
     let includes = Fpath.Set.add c.odoc_output_dir c.include_dirs in
     let link input_file output_file =
-      let { pkg_args = { libs; docs }; pkgdir = current_package, _; _ } = c in
-      Odoc.link ~input_file ~output_file ~includes ~libs ~docs ~current_package
-        ()
+      let { pkg_args = { libs; docs }; pkgname; _ } = c in
+      Odoc.link ~input_file ~output_file ~includes ~libs ~docs
+        ~current_package:pkgname.p_name ()
     in
     let impl =
       match c.impl with
@@ -287,7 +287,7 @@ let link : compiled list -> _ =
               m "Linking impl: %a -> %a" Fpath.pp impl_odoc Fpath.pp impl_odocl);
           link impl_odoc impl_odocl;
           Atomic.incr Stats.stats.linked_impls;
-          [ { pkgdir = c.pkgdir; output_file = impl_odocl; src = Some src } ]
+          [ { pkgname = c.pkgname; output_file = impl_odocl; src = Some src } ]
       | None -> []
     in
     match c.m with
@@ -300,13 +300,14 @@ let link : compiled list -> _ =
         (match c.m with
         | Module _ -> Atomic.incr Stats.stats.linked_units
         | Mld _ -> Atomic.incr Stats.stats.linked_mlds);
-        { output_file = c.odocl_file; src = None; pkgdir = c.pkgdir } :: impl
+        { output_file = c.odocl_file; src = None; pkgname = c.pkgname } :: impl
   in
   Fiber.List.map link compiled |> List.concat
 
 let index_one ~odocl_dir pkgname pkg =
-  let _, dir = pkg.Packages.pkgdir in
-  let output_file = Fpath.(odocl_dir // dir / Odoc.index_filename) in
+  let output_file =
+    Fpath.(odocl_dir // pkg.Packages.pkgname.p_dir / Odoc.index_filename)
+  in
   let libs =
     List.map
       (fun lib -> (lib.Packages.lib_name, Fpath.(odocl_dir // lib.odoc_dir)))
@@ -319,7 +320,7 @@ let index_one ~odocl_dir pkgname pkg =
 let index ~odocl_dir pkgs = Util.StringMap.iter (index_one ~odocl_dir) pkgs
 
 let sherlodoc_index_one ~html_dir ~odocl_dir _ pkg_content =
-  let _, pkg_dir = pkg_content.Packages.pkgdir in
+  let pkg_dir = pkg_content.Packages.pkgname.p_dir in
   let inputs = [ Fpath.(odocl_dir // pkg_dir / Odoc.index_filename) ] in
   let dst = Fpath.(html_dir // Sherlodoc.db_js_file pkg_dir) in
   let dst_dir, _ = Fpath.split_base dst in
@@ -337,15 +338,14 @@ let sherlodoc ~html_dir ~odocl_dir pkgs =
   let inputs =
     pkgs |> Util.StringMap.bindings
     |> List.map (fun (_pkgname, pkg) ->
-           let _, pkg_dir = pkg.Packages.pkgdir in
-           Fpath.(odocl_dir // pkg_dir / Odoc.index_filename))
+           Fpath.(odocl_dir // pkg.Packages.pkgname.p_dir / Odoc.index_filename))
   in
   Sherlodoc.index ~format ~inputs ~dst ()
 
 let html_generate output_dir ~odocl_dir linked =
   let html_generate : linked -> unit =
    fun l ->
-    let _, pkg_dir = l.pkgdir in
+    let pkg_dir = l.pkgname.p_dir in
     let search_uris = [ Sherlodoc.db_js_file pkg_dir; Sherlodoc.js_file ] in
     let index = Some Fpath.(odocl_dir // pkg_dir / Odoc.index_filename) in
     Odoc.html_generate ~search_uris ?index

src/driver/dune_style.ml

@@ -1,5 +1,10 @@
 (* Dune build tree *)
 
+(* Map lib names to package names. *)
+let mk_pkgname ~dir libname path =
+  let p_dir = Fpath.rem_prefix dir path |> Option.get in
+  { Packages.p_name = libname; p_dir }
+
 let of_dune_build dir =
   let contents =
     Bos.OS.Dir.fold_contents ~dotfiles:true (fun p acc -> p :: acc) [] dir
@@ -34,28 +39,27 @@ let of_dune_build dir =
             let cmtidir =
               Fpath.(path / Printf.sprintf ".%s.objs" libname / "byte")
             in
-            (* Map lib names to package names. *)
-            let pkgdir = (libname, Fpath.rem_prefix dir path |> Option.get) in
-            ( pkgdir,
-              Packages.Lib.v ~pkgdir
+            let pkgname = mk_pkgname ~dir libname path in
+            ( pkgname,
+              Packages.Lib.v ~pkgname
                 ~libname_of_archive:(Util.StringMap.singleton libname libname)
                 ~dir:path ~cmtidir:(Some cmtidir) ))
           libs
       in
       let packages =
         List.filter_map
-          (fun (pkgdir, lib) ->
+          (fun (pkgname, lib) ->
             match lib with
             | [ lib ] ->
+                (* Accept only one library per package for now. *)
                 Some
                   ( lib.Packages.lib_name,
                     {
-                      Packages.name = lib.Packages.lib_name;
-                      version = "1.0";
+                      Packages.version = "1.0";
                       libraries = [ lib ];
                       mlds = [];
                       mld_odoc_dir = Fpath.v lib.Packages.lib_name;
-                      pkgdir;
+                      pkgname;
                       other_docs = Fpath.Set.empty;
                     } )
             | _ -> None)

src/driver/indexes.ml

@@ -1,5 +1,5 @@
 let package fmt (pkg : Packages.t) =
-  Format.fprintf fmt "{0 Package %s}\n" pkg.name;
+  Format.fprintf fmt "{0 Package %s}\n" pkg.pkgname.p_name;
   Format.fprintf fmt "{1 Libraries}\n";
   List.iter
     (fun (lib : Packages.libty) ->

src/driver/packages.ml

@@ -1,6 +1,6 @@
 (* Packages *)
 
-type pkgdir = string * Fpath.t
+type pkgname = { p_name : string; p_dir : Fpath.t }
 
 type dep = string * Digest.t
 
@@ -34,7 +34,7 @@ type modulety = {
   m_intf : intf;
   m_impl : impl option;
   m_hidden : bool;
-  m_pkg : pkgdir;
+  m_pkgname : pkgname;
       (* The 'top dir' of a package, relative to [_odoc] or [_html] *)
 }
 
@@ -44,7 +44,7 @@ type mld = {
   mld_parent_id : id;
   mld_path : Fpath.t; (* Absolute or relative to cwd *)
   mld_deps : Fpath.t list;
-  mld_pkg : pkgdir;
+  mld_pkgname : pkgname;
       (* The 'top dir' of a package, relative to [_odoc] or [_html] *)
 }
 
@@ -58,26 +58,26 @@ type libty = {
 }
 
 type t = {
-  name : string;
+  pkgname : pkgname;
   version : string;
   libraries : libty list;
   mlds : mld list;
   mld_odoc_dir : Fpath.t; (* Relative to [odoc] dir *)
-  pkgdir : pkgdir;
   other_docs : Fpath.Set.t;
 }
 
 let maybe_prepend_top top_dir dir =
   match top_dir with None -> dir | Some d -> Fpath.(d // dir)
 
-let find_pkg top_dir pkg_name =
-  (pkg_name, maybe_prepend_top top_dir Fpath.(v pkg_name))
+let mk_pkgname top_dir p_name =
+  let p_dir = maybe_prepend_top top_dir Fpath.(v p_name) in
+  { p_name; p_dir }
 
-let parent_of_lib (_, pkg_dir) lib_name = Fpath.(pkg_dir / "lib" / lib_name)
+let parent_of_lib pkgname lib_name = Fpath.(pkgname.p_dir / "lib" / lib_name)
 
-let parent_of_pages (_, pkg_dir) = Fpath.(pkg_dir / "doc")
+let parent_of_pages pkgname = Fpath.(pkgname.p_dir / "doc")
 
-let parent_of_src (_, pkg_dir) lib_name = Fpath.(pkg_dir / "src" / lib_name)
+let parent_of_src pkgname lib_name = Fpath.(pkgname.p_dir / "src" / lib_name)
 
 module Module = struct
   type t = modulety
@@ -88,7 +88,7 @@ module Module = struct
 
   let is_hidden name = Astring.String.is_infix ~affix:"__" name
 
-  let vs pkgdir lib_name libsdir cmtidir modules =
+  let vs pkgname lib_name libsdir cmtidir modules =
     let dir = match cmtidir with None -> libsdir | Some dir -> dir in
     let mk m_name =
       let exists ext =
@@ -108,7 +108,7 @@ module Module = struct
             | _ -> None)
       in
       let mk_intf mif_path =
-        let mif_parent_id = parent_of_lib pkgdir lib_name in
+        let mif_parent_id = parent_of_lib pkgname lib_name in
         let mif_odoc_file =
           Fpath.(
             mif_parent_id
@@ -128,7 +128,7 @@ module Module = struct
         | Error _ -> failwith "bad deps"
       in
       let mk_impl mip_path =
-        let mip_parent_id = parent_of_lib pkgdir lib_name in
+        let mip_parent_id = parent_of_lib pkgname lib_name in
         let mip_odoc_file =
           Fpath.(
             mip_parent_id
@@ -151,7 +151,7 @@ module Module = struct
                   m "Found source file %a for %s" Fpath.pp src_path m_name);
               let src_name = Fpath.filename src_path in
               let src_id =
-                Fpath.(parent_of_src pkgdir lib_name / src_name)
+                Fpath.(parent_of_src pkgname lib_name / src_name)
                 |> Odoc.id_of_fpath
               in
               Some { src_path; src_id }
@@ -169,7 +169,7 @@ module Module = struct
       let m_hidden = is_hidden m_name in
       try
         let r (m_intf, m_impl) =
-          Some { m_name; m_intf; m_impl; m_hidden; m_pkg = pkgdir }
+          Some { m_name; m_intf; m_impl; m_hidden; m_pkgname = pkgname }
         in
         match state with
         | Some cmt, Some cmti -> r (mk_intf cmti, Some (mk_impl cmt))
@@ -187,10 +187,10 @@ module Module = struct
 end
 
 module Lib = struct
-  let v ~pkgdir ~libname_of_archive ~dir ~cmtidir =
-    let pkg_name, _ = pkgdir in
+  let v ~pkgname ~libname_of_archive ~dir ~cmtidir =
+    let { p_name; _ } = pkgname in
     Logs.debug (fun m ->
-        m "Classifying dir %a for package %s" Fpath.pp dir pkg_name);
+        m "Classifying dir %a for package %s" Fpath.pp dir p_name);
     let dirs =
       match cmtidir with None -> [ dir ] | Some dir2 -> [ dir; dir2 ]
     in
@@ -206,7 +206,7 @@ module Lib = struct
                   m
                     "Unable to determine library in package '%s' to which \
                      archive '%s' belongs"
-                    pkg_name archive_name);
+                    p_name archive_name);
               Logs.debug (fun m ->
                   m "These are the archives I know about: [%a]"
                     Fmt.(list ~sep:sp string)
@@ -215,8 +215,8 @@ module Lib = struct
                   m "Defaulting to name of library: %s" archive_name);
               archive_name
           in
-          let modules = Module.vs pkgdir lib_name dir cmtidir modules in
-          let odoc_dir = parent_of_lib pkgdir lib_name in
+          let modules = Module.vs pkgname lib_name dir cmtidir modules in
+          let odoc_dir = parent_of_lib pkgname lib_name in
           Some { lib_name; odoc_dir; archive_name; modules }
         with _ ->
           Logs.err (fun m ->
@@ -232,8 +232,8 @@ module Lib = struct
 end
 
 let pp ppf t =
-  Fmt.pf ppf "name: %[email protected]: %[email protected]: [@[<hov 2>@,%a@]@,]" t.name
-    t.version
+  Fmt.pf ppf "name: %[email protected]: %[email protected]: [@[<hov 2>@,%a@]@,]"
+    t.pkgname.p_name t.version
     Fmt.(list ~sep:sp Lib.pp)
     t.libraries
 
@@ -339,8 +339,8 @@ let of_libs ~packages_dir libs =
         match rel_path with
         | None -> acc
         | Some rel_path ->
-            let pkgdir = find_pkg packages_dir pkg_name in
-            let id = Fpath.(parent_of_pages pkgdir // rel_path) in
+            let pkgname = mk_pkgname packages_dir pkg_name in
+            let id = Fpath.(parent_of_pages pkgname // rel_path) in
             let mld_parent_id = id |> Fpath.parent |> Fpath.rem_empty_seg in
             let page_name = Fpath.(rem_ext mld_path |> filename) in
             let odoc_file =
@@ -354,7 +354,7 @@ let of_libs ~packages_dir libs =
               mld_parent_id = Odoc.id_of_fpath mld_parent_id;
               mld_path;
               mld_deps;
-              mld_pkg = pkgdir;
+              mld_pkgname = pkgname;
             }
             :: acc)
       odoc_pages []
@@ -373,10 +373,10 @@ let of_libs ~packages_dir libs =
           Logs.debug (fun m -> m "No package for dir %a\n%!" Fpath.pp dir);
           acc
       | Some pkg ->
-          let pkgdir = find_pkg packages_dir pkg.name in
+          let pkgname = mk_pkgname packages_dir pkg.name in
 
           let libraries =
-            Lib.v ~pkgdir ~libname_of_archive ~dir ~cmtidir:None
+            Lib.v ~pkgname ~libname_of_archive ~dir ~cmtidir:None
           in
           let libraries =
             List.filter
@@ -407,16 +407,15 @@ let of_libs ~packages_dir libs =
                       mlds = update_mlds pkg.mlds libraries;
                     }
               | None ->
-                  let mld_odoc_dir = parent_of_pages pkgdir in
+                  let mld_odoc_dir = parent_of_pages pkgname in
                   Some
                     {
-                      name = pkg.name;
+                      pkgname;
                       version = pkg.version;
                       libraries;
                       mlds;
                       mld_odoc_dir;
                       other_docs;
-                      pkgdir;
                     })
             acc)
     dirs Util.StringMap.empty