Type asset names

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

Author: panglesd

src/document/url.ml

@@ -190,6 +190,7 @@ module Path = struct
     | { iv = `AssetFile (parent, name); _ } ->
         let parent = from_identifier (parent :> any) in
         let kind = `File in
+        let name = AssetName.to_string name in
         mk ~parent kind name
 
   let from_identifier p =

src/model/names.ml

@@ -159,3 +159,4 @@ module LabelName = SimpleName
 module PageName = SimpleName
 module DefName = SimpleName
 module LocalName = SimpleName
+module AssetName = SimpleName

src/model/names.mli

@@ -100,3 +100,5 @@ module PageName : SimpleName
 module DefName : SimpleName
 
 module LocalName : SimpleName
+
+module AssetName : SimpleName

src/model/paths.ml

@@ -61,7 +61,7 @@ module Identifier = struct
     | `SourceLocationMod x -> name_aux (x :> t)
     | `SourceLocationInternal (x, anchor) ->
         name_aux (x :> t) ^ "#" ^ LocalName.to_string anchor
-    | `AssetFile (_, name) -> name
+    | `AssetFile (_, name) -> AssetName.to_string name
 
   let rec is_hidden : t -> bool =
    fun x ->
@@ -143,7 +143,8 @@ module Identifier = struct
         LocalName.to_string name :: full_name_aux (parent :> t)
     | `SourceLocationMod name -> full_name_aux (name :> t)
     | `SourcePage (parent, name) -> name :: full_name_aux (parent :> t)
-    | `AssetFile (parent, name) -> name :: full_name_aux (parent :> t)
+    | `AssetFile (parent, name) ->
+        AssetName.to_string name :: full_name_aux (parent :> t)
 
   let fullname : [< t_pv ] id -> string list =
    fun n -> List.rev @@ full_name_aux (n :> t)
@@ -497,8 +498,8 @@ module Identifier = struct
         [> `LeafPage of ContainerPage.t option * PageName.t ] id =
       mk_parent_opt PageName.to_string "lp" (fun (p, n) -> `LeafPage (p, n))
 
-    let asset_file : Page.t * string -> AssetFile.t =
-      mk_parent (fun k -> k) "asset" (fun (p, n) -> `AssetFile (p, n))
+    let asset_file : Page.t * AssetName.t -> AssetFile.t =
+      mk_parent AssetName.to_string "asset" (fun (p, n) -> `AssetFile (p, n))
 
     let source_page (container_page, path) =
       let rec source_dir dir =

src/model/paths.mli

@@ -253,7 +253,7 @@ module Identifier : sig
 
     val source_page : ContainerPage.t * string list -> SourcePage.t
 
-    val asset_file : Page.t * string -> AssetFile.t
+    val asset_file : Page.t * AssetName.t -> AssetFile.t
 
     val root :
       ContainerPage.t option * ModuleName.t ->

src/model/paths_types.ml

@@ -32,7 +32,7 @@ module Identifier = struct
   type source_page = source_page_pv id
   (** @canonical Odoc_model.Paths.Identifier.SourcePage.t *)
 
-  type asset_file_pv = [ `AssetFile of page * string ]
+  type asset_file_pv = [ `AssetFile of page * AssetName.t ]
   (** The second argument is the filename.
 
     @canonical Odoc_model.Paths.Identifier.AssetFile.t_pv *)

src/model/root.ml

@@ -94,7 +94,7 @@ let to_string t =
     | `AssetFile (parent, name) ->
         Format.fprintf fmt "%a::%s" pp
           (parent :> Paths.Identifier.OdocId.t)
-          name
+          (Names.AssetName.to_string name)
   in
 
   Format.asprintf "%a" pp t.id

src/model_desc/paths_desc.ml

@@ -36,6 +36,8 @@ module Names = struct
 
   let pagename = To_string PageName.to_string
 
+  let assetname = To_string AssetName.to_string
+
   let parametername = To_string ModuleName.to_string
 
   let defname = To_string DefName.to_string
@@ -77,7 +79,10 @@ module General_paths = struct
                 ((parent :> id_t option), name),
                 Pair (Option identifier, Names.pagename) )
         | `AssetFile (parent, name) ->
-            C ("`AssetFile", ((parent :> id_t), name), Pair (identifier, string))
+            C
+              ( "`AssetFile",
+                ((parent :> id_t), name),
+                Pair (identifier, Names.assetname) )
         | `Root (parent, name) ->
             C
               ( "`Root",

src/odoc/asset.ml

@@ -2,7 +2,8 @@ let compile ~parent_id ~name ~output_dir =
   let open Odoc_model in
   let parent_id = Compile.mk_id parent_id in
   let id =
-    Paths.Identifier.Mk.asset_file ((parent_id :> Paths.Identifier.Page.t), name)
+    Paths.Identifier.Mk.asset_file
+      ((parent_id :> Paths.Identifier.Page.t), Names.AssetName.make_std name)
   in
   let directory =
     Compile.path_of_id output_dir parent_id

src/odoc/html_page.ml

@@ -58,7 +58,10 @@ let asset_documents parent_id children asset_paths =
           Error.raise_warning (Error.filename_only "asset is missing." name);
           None
       | Some path ->
-          let asset_id = Paths.Identifier.Mk.asset_file (parent_id, name) in
+          let asset_id =
+            Paths.Identifier.Mk.asset_file
+              (parent_id, Names.AssetName.make_std name)
+          in
           let url = Odoc_document.Url.Path.from_identifier asset_id in
           Some (Odoc_document.Types.Document.Asset { url; src = path }))
     paired_or_missing