Occurrences: Constrain output file name

Similar to source trees: must have `odoc` extension and `occurrences-` prefix

Signed-off-by: Paul-Elliot <[email protected]>

Author: panglesd

doc/driver.mld

@@ -760,7 +760,7 @@ let compiled = compile_all () in
 let linked = link_all compiled in
 let () = index_generate () in
 let _ = js_index () in
-let _ = count_occurrences (Fpath.v "occurrences.txt") in
+let _ = count_occurrences (Fpath.v "occurrences-odoc_and_deps.odoc") in
 generate_all linked
 ]}
 

src/odoc/bin/main.ml

@@ -1111,9 +1111,21 @@ module Targets = struct
 end
 
 module Occurrences = struct
+  let has_occurrences_prefix input =
+    input |> Fs.File.basename |> Fs.File.to_string
+    |> Astring.String.is_prefix ~affix:"occurrences-"
+
+  let dst_of_string s =
+    let f = Fs.File.of_string s in
+    if not (Fs.File.has_ext ".odoc" f) then
+      Error (`Msg "Output file must have '.odoc' extension.")
+    else if not (has_occurrences_prefix f) then
+      Error (`Msg "Output file must be prefixed with 'occurrences-'.")
+    else Ok f
+  open Or_error
   module Count = struct
     let count directories dst warnings_options include_hidden =
-      let dst = Fpath.v dst in
+      dst_of_string dst >>= fun dst ->
       Occurrences.count ~dst ~warnings_options directories include_hidden
 
     let cmd =
@@ -1150,7 +1162,7 @@ module Occurrences = struct
               "At least one of --file-list or a path to a file must be passed \
                to odoc aggregate-occurrences")
       | _ ->
-          let dst = Fpath.v dst in
+          dst_of_string dst >>= fun dst ->
           Occurrences.aggregate ~dst ~warnings_options files file_list
 
     let cmd =

src/odoc/occurrences.ml

@@ -172,32 +172,34 @@ let parse_input_files input =
   >>= fun files -> Ok (List.concat files)
 
 let aggregate files file_list ~warnings_options:_ ~dst =
-  parse_input_files file_list >>= fun new_files ->
-  let files = files @ new_files in
-  let from_file file : Occtbl.t =
-    let ic = open_in_bin (Fs.File.to_string file) in
-    Marshal.from_channel ic
-  in
-  let rec loop n f =
-    if n > 0 then (
-      f ();
-      loop (n - 1) f)
-    else ()
-  in
-  let occtbl =
-    match files with
-    | [] -> H.create 0
-    | file1 :: files ->
-        let acc = from_file file1 in
-        List.iter
-          (fun file ->
-            Occtbl.iter
-              (fun id { direct; _ } ->
-                loop direct (fun () -> Occtbl.add acc id))
-              (from_file file))
-          files;
-        acc
-  in
-  let oc = open_out_bin (Fs.File.to_string dst) in
-  Marshal.to_channel oc occtbl [];
-  Ok ()
+  try
+    parse_input_files file_list >>= fun new_files ->
+    let files = files @ new_files in
+    let from_file file : Occtbl.t =
+      let ic = open_in_bin (Fs.File.to_string file) in
+      Marshal.from_channel ic
+    in
+    let rec loop n f =
+      if n > 0 then (
+        f ();
+        loop (n - 1) f)
+      else ()
+    in
+    let occtbl =
+      match files with
+      | [] -> H.create 0
+      | file1 :: files ->
+          let acc = from_file file1 in
+          List.iter
+            (fun file ->
+              Occtbl.iter
+                (fun id { direct; _ } ->
+                  loop direct (fun () -> Occtbl.add acc id))
+                (from_file file))
+            files;
+          acc
+    in
+    let oc = open_out_bin (Fs.File.to_string dst) in
+    Marshal.to_channel oc occtbl [];
+    Ok ()
+  with Sys_error s -> Error (`Msg s)

test/occurrences/double_wrapped.t/run.t

@@ -41,11 +41,11 @@ and a hashtable for each compilation unit.
   $ mv main__A.odocl main__A
   $ mv main__B.odocl main__B
   $ mv main__C.odocl main__C
-  $ odoc count-occurrences -I main -o main.occ
-  $ odoc count-occurrences -I main__ -o main__.occ
-  $ odoc count-occurrences -I main__A -o main__A.occ
-  $ odoc count-occurrences -I main__B -o main__B.occ
-  $ odoc count-occurrences -I main__C -o main__C.occ
+  $ odoc count-occurrences -I main -o occurrences-main.odoc
+  $ odoc count-occurrences -I main__ -o occurrences-main__.odoc
+  $ odoc count-occurrences -I main__A -o occurrences-main__A.odoc
+  $ odoc count-occurrences -I main__B -o occurrences-main__B.odoc
+  $ odoc count-occurrences -I main__C -o occurrences-main__C.odoc
 
 The occurrences_print executable, available only for testing, unmarshal the file
 and prints the number of occurrences in a readable format.
@@ -56,18 +56,18 @@ Uses of C are not counted, since the canonical destination (Main.C, generated by
 Uses of B.Z are not counted since they go to a hidden module.
 Uses of values Y.x and Z.y (in b.ml) are not counted since they come from a "local" module.
 
-  $ occurrences_print main.occ | sort
+  $ occurrences_print occurrences-main.odoc | sort
   Main was used directly 0 times and indirectly 2 times
   Main.A was used directly 1 times and indirectly 0 times
   Main.B was used directly 1 times and indirectly 0 times
 
-  $ occurrences_print main__.occ | sort
+  $ occurrences_print occurrences-main__.odoc | sort
 
 A only uses "persistent" values: one it defines itself.
-  $ occurrences_print main__A.occ | sort
+  $ occurrences_print occurrences-main__A.odoc | sort
 
 "Aliased" values are not counted since they become persistent
-  $ occurrences_print main__B.occ | sort
+  $ occurrences_print occurrences-main__B.odoc | sort
   Main was used directly 0 times and indirectly 7 times
   Main.A was used directly 2 times and indirectly 5 times
   Main.A.(||>) was used directly 1 times and indirectly 0 times
@@ -76,21 +76,21 @@ A only uses "persistent" values: one it defines itself.
   Main.A.x was used directly 1 times and indirectly 0 times
 
 "Aliased" values are not counted since they become persistent
-  $ occurrences_print main__C.occ | sort
+  $ occurrences_print occurrences-main__C.odoc | sort
   Main was used directly 0 times and indirectly 2 times
   Main.A was used directly 1 times and indirectly 1 times
   Main.A.x was used directly 1 times and indirectly 0 times
 
 Now we can merge all tables
 
   $ cat > files.map << EOF
-  > main__A.occ
-  > main__B.occ
-  > main__C.occ
+  > occurrences-main__A.odoc
+  > occurrences-main__B.odoc
+  > occurrences-main__C.odoc
   > EOF
-  $ odoc aggregate-occurrences main.occ main__.occ --file-list files.map -o aggregated.txt
+  $ odoc aggregate-occurrences occurrences-main.odoc occurrences-main__.odoc --file-list files.map -o occurrences-aggregated.odoc
 
-  $ occurrences_print aggregated.txt | sort > all_merged
+  $ occurrences_print occurrences-aggregated.odoc | sort > all_merged
   $ cat all_merged
   Main was used directly 0 times and indirectly 11 times
   Main.A was used directly 4 times and indirectly 6 times
@@ -102,17 +102,26 @@ Now we can merge all tables
 
 Compare with the one created directly with all occurrences:
 
-  $ odoc count-occurrences -I . -o occurrences.txt
-  $ occurrences_print occurrences.txt | sort > directly_all
+  $ odoc count-occurrences -I . -o occurrences-all.odoc
+  $ occurrences_print occurrences-all.odoc | sort > directly_all
   $ diff all_merged directly_all
 
 We can also include hidden ids:
 
-  $ odoc count-occurrences -I main__A -o occurrences.txt --include-hidden
-  $ occurrences_print occurrences.txt | sort
+  $ odoc count-occurrences -I main__B -o occurrences-b.odoc --include-hidden
+  $ occurrences_print occurrences-b.odoc | sort
+  Main was used directly 0 times and indirectly 7 times
+  Main.A was used directly 2 times and indirectly 5 times
+  Main.A.(||>) was used directly 1 times and indirectly 0 times
+  Main.A.M was used directly 2 times and indirectly 0 times
+  Main.A.t was used directly 1 times and indirectly 0 times
+  Main.A.x was used directly 1 times and indirectly 0 times
+  Main__ was used directly 0 times and indirectly 2 times
+  Main__.C was used directly 1 times and indirectly 1 times
+  Main__.C.y was used directly 1 times and indirectly 0 times
 
-  $ odoc count-occurrences -I . -o occurrences.txt --include-hidden
-  $ occurrences_print occurrences.txt | sort
+  $ odoc count-occurrences -I . -o occurrences-all.odoc --include-hidden
+  $ occurrences_print occurrences-all.odoc | sort
   Main was used directly 0 times and indirectly 11 times
   Main.A was used directly 4 times and indirectly 6 times
   Main.A.(||>) was used directly 1 times and indirectly 0 times