2072

Committed 10 Jun 2024 10:09AM UTC coverage: 71.986% (+0.2%) from 71.774%

Build # 2072

Build Type

Pull #1145

github

Committed by

web-flow

Commit Message

Merge 1b7b0910b into 1ced6f23f

Pull Request Pull Request #1145: "Global" Sidebar

Run Details

195 of 220 new or added lines in 12 files covered. (88.64%)

630 existing lines in 13 files now uncovered.

9834 of 13661 relevant lines covered (71.99%)

3561.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

21.05

/src/model/root.ml

(*
 * Copyright (c) 2014 Leo White <leo@lpw25.net>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

module Package = struct
  type t = string

  module Table = Hashtbl.Make (struct
    type nonrec t = t

    let equal : t -> t -> bool = ( = )

    let hash : t -> int = Hashtbl.hash
  end)
end

module Odoc_file = struct
  type compilation_unit = { name : string; hidden : bool }

  type page = { name : string; title : Comment.link_content option }

  type t =
    | Page of page
    | Compilation_unit of compilation_unit
    | Impl of string

  let create_unit ~force_hidden name =
    let hidden = force_hidden || Names.contains_double_underscore name in
    Compilation_unit { name; hidden }

  let create_page name title = Page { name; title }

  let create_impl name = Impl name

  let name = function
    | Page { name; _ } | Compilation_unit { name; _ } | Impl name -> name

  let hidden = function
    | Page _ | Impl _ -> false
    | Compilation_unit m -> m.hidden
end

type t = {
  id : Paths.Identifier.OdocId.t;
  file : Odoc_file.t;
  digest : Digest.t;
}

let equal : t -> t -> bool = ( = )

let hash : t -> int = Hashtbl.hash

let to_string t =
  let rec pp fmt (id : Paths.Identifier.OdocId.t) =
    match id.iv with
    | `SourcePage (parent, name) ->
        let rec loop_pp fmt parent =
          match parent.Paths.Identifier.iv with
          | `SourceDir (p, name) -> Format.fprintf fmt "%a::%s" loop_pp p name
          | `Page _ as iv -> Format.fprintf fmt "%a" pp { parent with iv }
        in
        Format.fprintf fmt "%a::%s" loop_pp parent name
    | `LeafPage (parent, name) | `Page (parent, name) -> (
        match parent with
        | Some p ->
            Format.fprintf fmt "%a::%a" pp
              (p :> Paths.Identifier.OdocId.t)
              Names.PageName.fmt name
        | None -> Format.fprintf fmt "%a" Names.PageName.fmt name)
    | `Root (Some parent, name) ->
        Format.fprintf fmt "%a::%a" pp
          (parent :> Paths.Identifier.OdocId.t)
          Names.ModuleName.fmt name
    | `Root (None, name) -> Format.fprintf fmt "%a" Names.ModuleName.fmt name
    | `Implementation name ->
        Format.fprintf fmt "impl(%a)" Names.ModuleName.fmt name
  in

  Format.asprintf "%a" pp t.id

let compare x y = String.compare x.digest y.digest

module Hash_table = Hashtbl.Make (struct
  type nonrec t = t

  let equal = equal

  let hash = hash
end)

1	(*
2	* Copyright (c) 2014 Leo White <leo@lpw25.net>
3	*
4	* Permission to use, copy, modify, and distribute this software for any
5	* purpose with or without fee is hereby granted, provided that the above
6	* copyright notice and this permission notice appear in all copies.
7	*
8	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11	* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13	* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15	*)
16
17	module Package = struct
18	type t = string
19
20	module Table = Hashtbl.Make (struct
21	type nonrec t = t
22
23	let equal : t -> t -> bool = ( = )
24
25	let hash : t -> int = Hashtbl.hash
26	end)
27	end
28
29	module Odoc_file = struct
30	type compilation_unit = { name : string; hidden : bool }
31
32	type page = { name : string; title : Comment.link_content option }
33
34	type t =
35	\| Page of page
36	\| Compilation_unit of compilation_unit
37	\| Impl of string
38
39	let create_unit ~force_hidden name =
40	let hidden = force_hidden \|\| Names.contains_double_underscore name in	1✔
41	Compilation_unit { name; hidden }
42
43	let create_page name title = Page { name; title }	42✔
44
45	let create_impl name = Impl name	31✔
46
47	let name = function
NEW 48	\| Page { name; _ } \| Compilation_unit { name; _ } \| Impl name -> name	×
49
50	let hidden = function
51	\| Page _ \| Impl _ -> false	×
52	\| Compilation_unit m -> m.hidden	142✔
53	end
54
55	type t = {
56	id : Paths.Identifier.OdocId.t;
57	file : Odoc_file.t;
58	digest : Digest.t;
59	}
60
61	let equal : t -> t -> bool = ( = )
62
63	let hash : t -> int = Hashtbl.hash
64
65	let to_string t =
66	let rec pp fmt (id : Paths.Identifier.OdocId.t) =	×
67	match id.iv with	×
68	\| `SourcePage (parent, name) ->	×
69	let rec loop_pp fmt parent =
70	match parent.Paths.Identifier.iv with	×
71	\| `SourceDir (p, name) -> Format.fprintf fmt "%a::%s" loop_pp p name	×
72	\| `Page _ as iv -> Format.fprintf fmt "%a" pp { parent with iv }	×
73	in
74	Format.fprintf fmt "%a::%s" loop_pp parent name
75	\| `LeafPage (parent, name) \| `Page (parent, name) -> (	×
76	match parent with
77	\| Some p ->	×
78	Format.fprintf fmt "%a::%a" pp
79	(p :> Paths.Identifier.OdocId.t)
80	Names.PageName.fmt name
81	\| None -> Format.fprintf fmt "%a" Names.PageName.fmt name)	×
82	\| `Root (Some parent, name) ->	×
83	Format.fprintf fmt "%a::%a" pp
84	(parent :> Paths.Identifier.OdocId.t)
85	Names.ModuleName.fmt name
86	\| `Root (None, name) -> Format.fprintf fmt "%a" Names.ModuleName.fmt name	×
87	\| `Implementation name ->	×
88	Format.fprintf fmt "impl(%a)" Names.ModuleName.fmt name
89	in
90
91	Format.asprintf "%a" pp t.id
92
93	let compare x y = String.compare x.digest y.digest	×
94
95	module Hash_table = Hashtbl.Make (struct
96	type nonrec t = t
97
98	let equal = equal
99
100	let hash = hash
101	end)

ocaml / odoc / 2072

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous