Search: Pass search scripts at html generation

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

Author: panglesd

src/document/generator.ml

@@ -1777,14 +1777,6 @@ module Make (Syntax : SYNTAX) = struct
 
     let compilation_unit (t : Odoc_model.Lang.Compilation_unit.t) =
       let url = Url.Path.from_identifier t.id in
-      let search_assets =
-        Utils.filter_map
-          (function
-            | `Resolved (`Identifier id) ->
-                Some Url.(from_path @@ Path.from_identifier id)
-            | _ -> None)
-          t.search_assets
-      in
       let unit_doc, items =
         match t.content with
         | Module sign -> signature sign
@@ -1796,7 +1788,7 @@ module Make (Syntax : SYNTAX) = struct
         | None -> None
       in
       let page = make_expansion_page ~source_anchor url [ unit_doc ] items in
-      Document.Page (page, search_assets)
+      Document.Page page
 
     let page (t : Odoc_model.Lang.Page.t) =
       (*let name =
@@ -1806,15 +1798,7 @@ module Make (Syntax : SYNTAX) = struct
       let url = Url.Path.from_identifier t.name in
       let preamble, items = Sectioning.docs t.content in
       let source_anchor = None in
-      let search_assets =
-        Utils.filter_map
-          (function
-            | `Resolved (`Identifier id) ->
-                Some (Url.from_path @@ Url.Path.from_identifier id)
-            | _ -> None)
-          t.search_assets
-      in
-      Document.Page ({ Page.preamble; items; url; source_anchor }, search_assets)
+      Document.Page { Page.preamble; items; url; source_anchor }
 
     let source_tree t =
       let dir_pages = t.Odoc_model.Lang.SourceTree.source_children in
@@ -1899,7 +1883,7 @@ module Make (Syntax : SYNTAX) = struct
           :: [ text ~attr:[ "odoc-folder-list" ] @@ list list_of_children ]
         in
         Document.Page
-          ({ Types.Page.preamble = []; items; url; source_anchor = None }, [])
+          { Types.Page.preamble = []; items; url; source_anchor = None }
       in
       M.fold (fun dir children acc -> page_of_dir dir children :: acc) mmap []
   end

src/document/types.ml

@@ -198,10 +198,7 @@ end =
   Asset
 
 module Document = struct
-  type t =
-    | Page of Page.t * Url.t list
-    | Source_page of Source_page.t
-    | Asset of Asset.t
+  type t = Page of Page.t | Source_page of Source_page.t | Asset of Asset.t
 end
 
 let inline ?(attr = []) desc = Inline.{ attr; desc }

src/html/config.ml

@@ -3,6 +3,7 @@
 type t = {
   theme_uri : Types.uri option;
   support_uri : Types.uri option;
+  search_uris : Types.file_uri list;
   semantic_uris : bool;
   search_result : bool;
       (* Used to not render links, for summary in search results *)
@@ -12,25 +13,28 @@ type t = {
   as_json : bool;
 }
 
-let v ?(search_result = false) ?theme_uri ?support_uri ~semantic_uris ~indent
-    ~flat ~open_details ~as_json () =
+let v ?(search_result = false) ?theme_uri ?support_uri ?(search_uris = [])
+    ~semantic_uris ~indent ~flat ~open_details ~as_json () =
   {
     semantic_uris;
     indent;
     flat;
     open_details;
     theme_uri;
     support_uri;
+    search_uris;
     as_json;
     search_result;
   }
 
-let theme_uri config =
+let theme_uri config : Types.uri =
   match config.theme_uri with None -> Types.Relative None | Some uri -> uri
 
-let support_uri config =
+let support_uri config : Types.uri =
   match config.support_uri with None -> Types.Relative None | Some uri -> uri
 
+let search_uris config = config.search_uris
+
 let semantic_uris config = config.semantic_uris
 
 let indent config = config.indent

src/html/config.mli

@@ -8,6 +8,7 @@ val v :
      In that case, the links will be printed as regular text. *) ->
   ?theme_uri:Types.uri ->
   ?support_uri:Types.uri ->
+  ?search_uris:Types.file_uri list ->
   semantic_uris:bool ->
   indent:bool ->
   flat:bool ->
@@ -20,6 +21,8 @@ val theme_uri : t -> Types.uri
 
 val support_uri : t -> Types.uri
 
+val search_uris : t -> Types.file_uri list
+
 val semantic_uris : t -> bool
 
 val indent : t -> bool

src/html/generator.ml

@@ -482,26 +482,20 @@ module Page = struct
         | `Closed | `Open | `Default -> None
         | `Inline -> Some 0)
 
-  let rec include_ ~config search_assets { Subpage.content; _ } =
-    page ~config search_assets content
+  let rec include_ ~config { Subpage.content; _ } = page ~config content
 
-  and subpages ~config search_assets subpages =
-    List.map (include_ ~config search_assets) subpages
+  and subpages ~config subpages = List.map (include_ ~config) subpages
 
-  and page ~config (search_assets : Odoc_document.Url.t list) p :
-      Odoc_document.Renderer.page =
+  and page ~config p : Odoc_document.Renderer.page =
     let { Page.preamble; items = i; url; source_anchor } =
       Doctree.Labels.disambiguate_page ~enter_subpages:false p
     in
-    let subpages =
-      subpages ~config search_assets @@ Doctree.Subpages.compute p
-    in
+    let subpages = subpages ~config @@ Doctree.Subpages.compute p in
     let resolve = Link.Current url in
     let i = Doctree.Shift.compute ~on_sub i in
     let uses_katex = Doctree.Math.has_math_elements p in
     let toc = Toc.gen_toc ~config ~resolve ~path:url i in
     let breadcrumbs = Breadcrumbs.gen_breadcrumbs ~config ~url in
-    let search_urls = List.map (Link.href ~config ~resolve) search_assets in
     let content = (items ~config ~resolve i :> any Html.elt list) in
     if Config.as_json config then
       let source_anchor =
@@ -517,8 +511,8 @@ module Page = struct
         items ~config ~resolve
           (Doctree.PageTitle.render_title ?source_anchor p @ preamble)
       in
-      Html_page.make ~config ~header ~toc ~breadcrumbs ~url ~uses_katex
-        ~search_urls content subpages
+      Html_page.make ~config ~header ~toc ~breadcrumbs ~url ~uses_katex content
+        subpages
 
   and source_page ~config sp =
     let { Source_page.url; contents } = sp in
@@ -555,8 +549,7 @@ module Page = struct
 end
 
 let render ~config = function
-  | Document.Page (page, search_assets) ->
-      [ Page.page ~config search_assets page ]
+  | Document.Page page -> [ Page.page ~config page ]
   | Source_page src -> [ Page.source_page ~config src ]
   | Asset asset -> [ Page.asset ~config asset ]
 

src/html/html_page.ml

@@ -86,30 +86,37 @@ let html_of_breadcrumbs (breadcrumbs : Types.breadcrumb list) =
       make_navigation ~up_url:up.href
         (List.rev html @ sep @ [ Html.txt current.name ])
 
-let page_creator ~config ~url ~uses_katex ~search_urls header breadcrumbs toc
-    content =
+let page_creator ~config ~url ~uses_katex header breadcrumbs toc content =
   let theme_uri = Config.theme_uri config in
   let support_uri = Config.support_uri config in
+  let search_uris = Config.search_uris config in
   let path = Link.Path.for_printing url in
 
   let head : Html_types.head Html.elt =
     let title_string =
       Printf.sprintf "%s (%s)" url.name (String.concat "." path)
     in
 
-    let file_uri base file =
+    let file_uri (base : Types.uri) file =
       match base with
       | Types.Absolute uri -> uri ^ "/" ^ file
       | Relative uri ->
           let page = Url.Path.{ kind = `File; parent = uri; name = file } in
           Link.href ~config ~resolve:(Current url) (Url.from_path page)
     in
+    let search_uri uri =
+      match uri with
+      | Types.Absolute uri -> uri
+      | Relative uri ->
+          Link.href ~config ~resolve:(Current url) (Url.from_path uri)
+    in
     let odoc_css_uri = file_uri theme_uri "odoc.css" in
     let highlight_js_uri = file_uri support_uri "highlight.pack.js" in
     let search_scripts =
-      match search_urls with
+      match search_uris with
       | [] -> []
-      | search_urls ->
+      | _ ->
+          let search_urls = List.map search_uri search_uris in
           let search_urls =
             let search_url name = Printf.sprintf "'%s'" name in
             let search_urls = List.map search_url search_urls in
@@ -120,7 +127,10 @@ let page_creator ~config ~url ~uses_katex ~search_urls header breadcrumbs toc
           [
             Html.script ~a:[]
               (Html.txt
-                 (Format.asprintf "let base_url = '%s'; let search_urls = %s;"
+                 (Format.asprintf
+                    {|let base_url = '%s';
+let search_urls = %s;
+|}
                     (let page =
                        Url.Path.{ kind = `File; parent = None; name = "" }
                      in
@@ -185,7 +195,7 @@ let page_creator ~config ~url ~uses_katex ~search_urls header breadcrumbs toc
     Html.head (Html.title (Html.txt title_string)) meta_elements
   in
   let search_bar =
-    match search_urls with
+    match search_uris with
     | [] -> []
     | _ ->
         [ Html.div ~a:[ Html.a_class [ "odoc-search" ] ] [ html_of_search () ] ]
@@ -208,12 +218,10 @@ let page_creator ~config ~url ~uses_katex ~search_urls header breadcrumbs toc
   in
   content
 
-let make ~config ~url ~header ~breadcrumbs ~toc ~uses_katex ~search_urls content
-    children =
+let make ~config ~url ~header ~breadcrumbs ~toc ~uses_katex content children =
   let filename = Link.Path.as_filename ~is_flat:(Config.flat config) url in
   let content =
-    page_creator ~config ~url ~uses_katex ~search_urls header breadcrumbs toc
-      content
+    page_creator ~config ~url ~uses_katex header breadcrumbs toc content
   in
   { Odoc_document.Renderer.filename; content; children }
 
@@ -230,7 +238,7 @@ let src_page_creator ~breadcrumbs ~config ~url ~header name content =
     let title_string =
       Format.asprintf "Source: %s%a" name path_of_module_of_source url
     in
-    let file_uri base file =
+    let file_uri (base : Types.uri) file =
       match base with
       | Types.Absolute uri -> uri ^ "/" ^ file
       | Relative uri ->

src/html/html_page.mli

@@ -27,7 +27,6 @@ val make :
   breadcrumbs:Types.breadcrumb list ->
   toc:Types.toc list ->
   uses_katex:bool ->
-  search_urls:string list ->
   Html_types.div_content Html.elt list ->
   Odoc_document.Renderer.page list ->
   Odoc_document.Renderer.page

src/html/types.ml

@@ -2,6 +2,8 @@
 
 type uri = Absolute of string | Relative of Odoc_document.Url.Path.t option
 
+type file_uri = Absolute of string | Relative of Odoc_document.Url.Path.t
+
 type toc = {
   title : Html_types.flow5_without_interactive Tyxml.Html.elt list;
   title_str : string;

src/latex/generator.ml

@@ -488,5 +488,5 @@ module Page = struct
 end
 
 let render ~with_children = function
-  | Document.Page (page, _) -> [ Page.page ~with_children page ]
+  | Document.Page page -> [ Page.page ~with_children page ]
   | Source_page _ | Asset _ -> []

src/loader/odoc_loader.ml

@@ -52,7 +52,7 @@ let read_cmt_infos source_id_opt id ~filename () =
 
 
 let make_compilation_unit ~make_root ~imports ~interface ?sourcefile ~name ~id
-    ?canonical ?shape_info ~source_info ~search_assets content =
+    ?canonical ?shape_info ~source_info content =
   let open Odoc_model.Lang.Compilation_unit in
   let interface, digest =
     match interface with
@@ -90,7 +90,6 @@ let make_compilation_unit ~make_root ~imports ~interface ?sourcefile ~name ~id
     canonical;
     source_info;
     shape_info;
-    search_assets;
   }
 
 
@@ -100,7 +99,7 @@ let compilation_unit_of_sig ~make_root ~imports ~interface ?sourcefile ~name ~id
   make_compilation_unit ~make_root ~imports ~interface ?sourcefile ~name ~id
     ?canonical ?shape_info content
 
-let read_cmti ~make_root ~parent ~filename ~search_assets ~cmt_filename_opt ~source_id_opt () =
+let read_cmti ~make_root ~parent ~filename ~cmt_filename_opt ~source_id_opt () =
   let cmt_info = Cmt_format.read_cmt filename in
   match cmt_info.cmt_annots with
   | Interface intf -> (
@@ -121,11 +120,11 @@ let read_cmti ~make_root ~parent ~filename ~search_assets ~cmt_filename_opt ~sou
             | None -> (None, None)
           in
           compilation_unit_of_sig ~make_root ~imports:cmt_info.cmt_imports
-            ~interface ~sourcefile ~name ~id ?shape_info ~source_info ~search_assets
+            ~interface ~sourcefile ~name ~id ?shape_info ~source_info
             ?canonical sg)
   | _ -> raise Not_an_interface
 
-let read_cmt ~make_root ~parent ~filename ~search_assets ~source_id_opt () =
+let read_cmt ~make_root ~parent ~filename ~source_id_opt () =
   match Cmt_format.read_cmt filename with
   | exception Cmi_format.Error (Not_an_interface _) ->
       raise Not_an_implementation
@@ -165,14 +164,14 @@ let read_cmt ~make_root ~parent ~filename ~search_assets ~source_id_opt () =
           in
           let content = Odoc_model.Lang.Compilation_unit.Pack items in
           make_compilation_unit ~make_root ~imports ~interface ~sourcefile ~name
-            ~id  ~search_assets ~source_info:None content
+            ~id  ~source_info:None content
       | Implementation impl ->
           let id, sg, canonical = Cmt.read_implementation parent name impl in
           let shape_info, source_info =
             read_cmt_infos source_id_opt id ~filename ()
           in
           compilation_unit_of_sig ~make_root ~imports ~interface ~sourcefile
-            ~name ~id ?canonical ?shape_info  ~search_assets ~source_info sg
+            ~name ~id ?canonical ?shape_info  ~source_info sg
       | _ -> raise Not_an_implementation)
 
 let read_cmi ~make_root ~parent ~filename () =
@@ -200,14 +199,14 @@ let wrap_errors ~filename f =
       | Not_an_interface -> not_an_interface filename
       | Make_root_error m -> error_msg filename m)
 
-let read_cmti ~make_root ~parent ~filename ~source_id_opt ~cmt_filename_opt  ~search_assets =
+let read_cmti ~make_root ~parent ~filename ~source_id_opt ~cmt_filename_opt =
   wrap_errors ~filename
-    (read_cmti ~make_root ~parent ~filename ~source_id_opt ~cmt_filename_opt  ~search_assets)
+    (read_cmti ~make_root ~parent ~filename ~source_id_opt ~cmt_filename_opt)
 
-let read_cmt ~make_root ~parent ~filename ~source_id_opt ~search_assets =
-  wrap_errors ~filename (read_cmt ~make_root ~parent ~filename ~source_id_opt ~search_assets)
+let read_cmt ~make_root ~parent ~filename ~source_id_opt =
+  wrap_errors ~filename (read_cmt ~make_root ~parent ~filename ~source_id_opt)
 
-let read_cmi ~make_root ~parent ~filename ~search_assets =
-  wrap_errors ~filename (read_cmi ~make_root ~parent ~filename ~search_assets)
+let read_cmi ~make_root ~parent ~filename =
+  wrap_errors ~filename (read_cmi ~make_root ~parent ~filename)
 
 let read_location = Doc_attr.read_location