Compatibility with Odoc 3

Several changes:
- Entries are now defined in the `odoc_index` library,
- Entries can have new kinds (pages, source, ...)
- Indexes have the form of "skeletons of entries", that can be folded.
- Indexes can be created by odoc with the `odoc compile-index` command, and
  then consumed by sherlodoc.

These changes come from:
- ocaml/odoc#1228
- ocaml/odoc#1232
- ocaml/odoc#1233
- ocaml/odoc#1244
- ocaml/odoc#1250
- ocaml/odoc#1251

Author: panglesd

cli/search.ml

@@ -17,6 +17,8 @@ let string_of_kind =
   | Constructor _ -> "cons"
   | Field _ -> "field"
   | Val _ -> "val"
+  | Page -> "page"
+  | Impl -> "source"
 
 let print_result ~print_cost ~print_docstring ~no_rhs (elt : Db.Entry.t) =
   let cost = if print_cost then string_of_int elt.cost ^ " " else "" in

db/entry.ml

@@ -6,7 +6,9 @@ let non_empty_string s =
 
 module Kind = struct
   type t =
-    | Doc
+    | Doc (** Standalone doc comment *)
+    | Page (** Mld page *)
+    | Impl (** Source page *)
     | Module
     | Module_type
     | Class
@@ -26,7 +28,7 @@ module Kind = struct
     match t with
     | Val typ | Extension_constructor typ | Exception typ | Constructor typ | Field typ ->
       Some typ
-    | Doc | Module | Module_type | Class | Class_type | Method | Type_decl _
+    | Doc | Page | Impl | Module | Module_type | Class | Class_type | Method | Type_decl _
     | Type_extension ->
       None
 end

db/entry.mli

@@ -1,6 +1,8 @@
 module Kind : sig
   type t =
-    | Doc
+    | Doc (** Standalone doc comment *)
+    | Page (** Mld page *)
+    | Impl (** Source page *)
     | Module
     | Module_type
     | Class

index/index.ml

@@ -3,17 +3,13 @@ let index_file register filename =
   | Error (`Msg msg) -> Format.printf "FILE ERROR %s: %s@." filename msg
   | Ok file ->
     let open Odoc_model in
-    let page p =
-      let id = p.Lang.Page.name in
-      Fold.page ~f:(register (id :> Paths.Identifier.t)) () p
-    in
-    let unit u =
-      let id = u.Lang.Compilation_unit.id in
-      Fold.unit ~f:(register (id :> Paths.Identifier.t)) () u
-    in
-    (match Odoc_odoc.Indexing.handle_file ~page ~unit file with
+    let page p = register [ Odoc_index.Skeleton.from_page p ] in
+    let unit u = register [ Odoc_index.Skeleton.from_unit u ] in
+    let occ o = register o in
+    (match Odoc_odoc.Indexing.handle_file ~page ~unit ~occ file with
      | Ok result -> result
-     | Error (`Msg msg) -> Format.printf "Odoc warning or error %s: %s@." filename msg)
+     | Error (`Msg msg) ->
+       Format.printf "Odoc warning or error %a: %s@." Fpath.pp file msg)
 
 let main
   files
@@ -29,17 +25,18 @@ let main
   let module Storage = (val Db_store.storage_module db_format) in
   let db = Db_writer.make () in
   let no_pkg = Db.Entry.Package.v ~name:"" ~version:"" in
-  let register ~pkg ~favourite id () item =
+  let register ~pkg ~favourite =
     List.iter
-      (Load_doc.register_entry
-         ~db
-         ~index_docstring
-         ~index_name
-         ~type_search
-         ~favourite
-         ~favoured_prefixes
-         ~pkg)
-      (Odoc_search.Entry.entries_of_item id item)
+    @@ Odoc_utils.Tree.iter
+         ~f:
+           (Load_doc.register_entry
+              ~db
+              ~index_docstring
+              ~index_name
+              ~type_search
+              ~favourite
+              ~favoured_prefixes
+              ~pkg)
   in
   let files =
     match file_list with
@@ -109,7 +106,7 @@ let odoc_favourite_file =
   Arg.(value & opt_all file [] & info [ "favoured" ] ~doc)
 
 let odoc_files =
-  let doc = "Path to a .odocl file" in
+  let doc = "Path to a .odocl file or a .odoc-index file" in
   Arg.(value & (pos_all file [] @@ info ~doc ~docv:"ODOCL_FILE" []))
 
 let term =

index/load_doc.ml

@@ -99,7 +99,7 @@ let searchable_type_of_constructor args res =
 let searchable_type_of_record parent_type type_ =
   Odoc_model.Lang.TypeExpr.Arrow (None, parent_type, type_)
 
-let convert_kind ~db (Odoc_search.Entry.{ kind; _ } as entry) =
+let convert_kind ~db (Odoc_index.Entry.{ kind; _ } as entry) =
   match kind with
   | TypeDecl _ -> Entry.Kind.Type_decl (Odoc_search.Html.typedecl_params_of_entry entry)
   | Value { value = _; type_ } ->
@@ -121,13 +121,16 @@ let convert_kind ~db (Odoc_search.Entry.{ kind; _ } as entry) =
     let typ = searchable_type_of_record parent_type type_ in
     let typ = Db_writer.type_of_odoc ~db typ in
     Entry.Kind.Field typ
-  | Doc _ -> Doc
+  | Doc -> Doc
+  | Dir -> Doc
+  | Page _ -> Doc
   | Class_type _ -> Class_type
   | Method _ -> Method
   | Class _ -> Class
   | TypeExtension _ -> Type_extension
-  | Module -> Entry.Kind.Module
-  | ModuleType -> Module_type
+  | Module _ -> Entry.Kind.Module
+  | ModuleType _ -> Module_type
+  | Impl -> Doc
 
 let register_type_expr ~db elt typ =
   let type_polarities = Db.Type_polarity.of_typ ~any_is_poly:true typ in
@@ -150,11 +153,11 @@ let rec categorize id =
     | `ExtensionDecl _ | `Module _ ) as x ->
     let parent = Identifier.label_parent { id with iv = x } in
     categorize (parent :> Identifier.Any.t)
-  | `AssetFile _ | `SourceDir _ | `SourceLocationMod _ | `SourceLocation _ | `SourcePage _
+  | `AssetFile _ | `SourceLocationMod _ | `SourceLocation _ | `SourcePage _
   | `SourceLocationInternal _ ->
     `ignore (* unclear what to do with those *)
 
-let categorize Odoc_search.Entry.{ id; _ } =
+let categorize Odoc_index.Entry.{ id; _ } =
   match id.iv with
   | `ModuleType (parent, _) ->
     (* A module type itself is not *from* a module type, but it might be if one
@@ -171,7 +174,7 @@ let register_entry
   ~favoured_prefixes
   ~pkg
   ~cat
-  (Odoc_search.Entry.{ id; doc; kind } as entry)
+  (Odoc_index.Entry.{ id; doc; kind } as entry)
   =
   let module Sherlodoc_entry = Entry in
   let open Odoc_search in
@@ -199,15 +202,15 @@ let register_entry
   ~favourite
   ~favoured_prefixes
   ~pkg
-  (Odoc_search.Entry.{ id; kind; _ } as entry)
+  (Odoc_index.Entry.{ id; kind; _ } as entry)
   =
   let cat = categorize entry in
   let is_pure_documentation =
     match kind with
-    | Doc _ -> true
+    | Doc | Page _ | Dir | Impl -> true
     | _ -> false
   in
-  if is_pure_documentation || cat = `ignore || Odoc_model.Paths.Identifier.is_internal id
+  if is_pure_documentation || cat = `ignore || Odoc_model.Paths.Identifier.is_hidden id
   then ()
   else
     register_entry

index/load_doc.mli

@@ -6,7 +6,7 @@ val register_entry
   -> favourite:bool
   -> favoured_prefixes:string list
   -> pkg:Db.Entry.Package.t
-  -> Odoc_search.Entry.t
+  -> Odoc_index.Entry.t
   -> unit
 (** [register_entry ~db ~index_name ~type_search ~index_docstring e] register
     the entry [e] in [db]. *)

jsoo/main.ml

@@ -81,6 +81,8 @@ let string_of_kind =
   let open Odoc_html_frontend in
   function
   | Db.Entry.Kind.Doc -> kind_doc
+  | Page -> kind_doc
+  | Impl -> kind_impl
   | Type_decl _ -> kind_typedecl
   | Module -> kind_module
   | Exception _ -> kind_exception

jsoo/odoc_html_frontend.ml

@@ -49,3 +49,4 @@ let kind_constructor = "cons"
 let kind_field = "field"
 let kind_value = "val"
 let kind_extension = "ext"
+let kind_impl = "source"

test/cram/cli.t/run.t

@@ -3,9 +3,10 @@
   $ odoc compile -I . page.mld
   $ odoc link -I . main.odoc
   $ odoc link -I . page-page.odoc
+  $ odoc compile-index -o index.odoc-index --root ./
   $ export SHERLODOC_DB=db.bin
   $ export SHERLODOC_FORMAT=marshal
-  $ sherlodoc index $(find . -name '*.odocl')
+  $ sherlodoc index index.odoc-index
   $ sherlodoc search "unique_name"
   val Main.unique_name : foo
   $ sherlodoc search "multiple_hit"