Fully remove Assets from the document abstraction

Author: panglesd

src/document/renderer.ml

@@ -24,6 +24,7 @@ type input =
 type 'a t = {
   name : string;
   render : 'a -> Types.Block.t option -> Types.Document.t -> page list;
+  filepath : 'a -> Url.Path.t -> Fpath.t;
 }
 
 let document_of_page ~syntax v =
@@ -38,7 +39,3 @@ let document_of_compilation_unit ~syntax v =
   match syntax with
   | Reason -> Reason.compilation_unit v
   | OCaml -> ML.compilation_unit v
-
-let document_of_asset path (v : Odoc_model.Lang.Asset.t) =
-  let url = Url.Path.from_identifier v.name in
-  Types.Document.Asset { url; src = path }

src/document/types.ml

@@ -196,13 +196,8 @@ and Source_page : sig
 end =
   Source_page
 
-and Asset : sig
-  type t = { url : Url.Path.t; src : Fpath.t }
-end =
-  Asset
-
 module Document = struct
-  type t = Page of Page.t | Source_page of Source_page.t | Asset of Asset.t
+  type t = Page of Page.t | Source_page of Source_page.t
 end
 
 let inline ?(attr = []) desc = Inline.{ attr; desc }

src/html/generator.ml

@@ -535,32 +535,14 @@ module Page = struct
     if Config.as_json config then
       Html_fragment_json.make_src ~config ~url ~breadcrumbs [ doc ]
     else Html_page.make_src ~breadcrumbs ~header ~config ~url title [ doc ]
-
-  let asset ~config { Asset.url; src } =
-    let filename = Link.Path.as_filename ~is_flat:(Config.flat config) url in
-    let content ppf =
-      let ic = open_in_bin (Fpath.to_string src) in
-      let len = 1024 in
-      let buf = Bytes.create len in
-      let rec loop () =
-        let read = input ic buf 0 len in
-        if read = len then (
-          Format.fprintf ppf "%s" (Bytes.to_string buf);
-          loop ())
-        else if len > 0 then
-          let buf = Bytes.sub buf 0 read in
-          Format.fprintf ppf "%s" (Bytes.to_string buf)
-      in
-      loop ();
-      close_in ic
-    in
-    { Odoc_document.Renderer.filename; content; children = [] }
 end
 
 let render ~config ~sidebar = function
   | Document.Page page -> [ Page.page ~config ~sidebar page ]
   | Source_page src -> [ Page.source_page ~config src ]
-  | Asset asset -> [ Page.asset ~config asset ]
+
+let filepath ~config url =
+  Link.Path.as_filename ~is_flat:(Config.flat config) url
 
 let doc ~config ~xref_base_uri b =
   let resolve = Link.Base xref_base_uri in

src/html/generator.mli

@@ -4,6 +4,8 @@ val render :
   Odoc_document.Types.Document.t ->
   Odoc_document.Renderer.page list
 
+val filepath : config:Config.t -> Odoc_document.Url.Path.t -> Fpath.t
+
 val doc :
   config:Config.t ->
   xref_base_uri:string ->

src/latex/generator.ml

@@ -40,10 +40,10 @@ module Link = struct
     ( List.map segment_to_string dir,
       String.concat "." (List.map segment_to_string file) )
 
-  let filename url =
+  let filename ?(add_ext = true) url =
     let dir, file = get_dir_and_file url in
     let file = Fpath.(v (String.concat dir_sep (dir @ [ file ]))) in
-    Fpath.(add_ext "tex" file)
+    if add_ext then Fpath.add_ext "tex" file else file
 end
 
 let style = function
@@ -477,4 +477,6 @@ end
 
 let render ~with_children = function
   | Document.Page page -> [ Page.page ~with_children page ]
-  | Source_page _ | Asset _ -> []
+  | Source_page _ -> []
+
+let filepath url = Link.filename ~add_ext:false url

src/latex/generator.mli

@@ -6,3 +6,5 @@ val render :
   with_children:bool ->
   Odoc_document.Types.Document.t ->
   Odoc_document.Renderer.page list
+
+val filepath : Odoc_document.Url.Path.t -> Fpath.t

src/manpage/generator.ml

@@ -562,4 +562,6 @@ and render_page (p : Page.t) =
 
 let render = function
   | Document.Page page -> [ render_page page ]
-  | Source_page _ | Asset _ -> []
+  | Source_page _ -> []
+
+let filepath url = Link.as_filename ~add_ext:false url

src/manpage/generator.mli

@@ -1 +1,3 @@
 val render : Odoc_document.Types.Document.t -> Odoc_document.Renderer.page list
+
+val filepath : Odoc_document.Url.Path.t -> Fpath.t

src/manpage/link.ml

@@ -7,7 +7,7 @@ let segment_to_string (kind, name) =
   | `Module | `Page | `LeafPage | `Class -> name
   | _ -> Format.asprintf "%a-%s" Odoc_document.Url.Path.pp_kind kind name
 
-let as_filename (url : Url.Path.t) =
+let as_filename ?(add_ext = true) (url : Url.Path.t) =
   let components = Url.Path.to_list url in
   let dir, path =
     Url.Path.split
@@ -17,7 +17,7 @@ let as_filename (url : Url.Path.t) =
   let dir = List.map segment_to_string dir in
   let path = String.concat "." (List.map segment_to_string path) in
   let str_path = String.concat Fpath.dir_sep (dir @ [ path ]) in
-  Fpath.(v str_path + ".3o")
+  if add_ext then Fpath.(v str_path + ".3o") else Fpath.v str_path
 
 let rec is_class_or_module_path (url : Url.Path.t) =
   match url.kind with

src/odoc/fs.ml

@@ -21,6 +21,18 @@ type directory = Fpath.t
 
 type file = Fpath.t
 
+let mkdir_p dir =
+  let mkdir d =
+    try Unix.mkdir (Fpath.to_string d) 0o755 with
+    | Unix.Unix_error (Unix.EEXIST, _, _) -> ()
+    | exn -> raise exn
+  in
+  let rec dirs_to_create p acc =
+    if Sys.file_exists (Fpath.to_string p) then acc
+    else dirs_to_create (Fpath.parent p) (p :: acc)
+  in
+  List.iter (dirs_to_create dir []) ~f:mkdir
+
 module File = struct
   type t = file
 
@@ -92,6 +104,27 @@ module File = struct
           Result.Error (`Msg err)
     with Sys_error e -> Result.Error (`Msg e)
 
+  let copy ~src ~dst =
+    let with_ open_ close filename f =
+      let c = open_ (Fpath.to_string filename) in
+      Odoc_utils.Fun.protect ~finally:(fun () -> close c) (fun () -> f c)
+    in
+    let with_ic = with_ open_in_bin close_in_noerr in
+    let with_oc = with_ open_out_bin close_out_noerr in
+    try
+      with_ic src (fun ic ->
+          mkdir_p (dirname dst);
+          with_oc dst (fun oc ->
+              let len = 1024 in
+              let buf = Bytes.create len in
+              let rec loop () =
+                let read = input ic buf 0 len in
+                output oc buf 0 read;
+                if read = len then loop ()
+              in
+              Ok (loop ())))
+    with Sys_error e -> Result.Error (`Msg e)
+
   let exists file = Sys.file_exists (Fpath.to_string file)
 
   let rec of_segs_tl acc = function
@@ -140,17 +173,7 @@ module Directory = struct
 
   let contains ~parentdir f = Fpath.is_rooted ~root:parentdir f
 
-  let mkdir_p dir =
-    let mkdir d =
-      try Unix.mkdir (Fpath.to_string d) 0o755 with
-      | Unix.Unix_error (Unix.EEXIST, _, _) -> ()
-      | exn -> raise exn
-    in
-    let rec dirs_to_create p acc =
-      if Sys.file_exists (Fpath.to_string p) then acc
-      else dirs_to_create (Fpath.parent p) (p :: acc)
-    in
-    List.iter (dirs_to_create dir []) ~f:mkdir
+  let mkdir_p dir = mkdir_p dir
 
   let to_string = Fpath.to_string