Source file `namespace.ml`

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2022 Nomadic Labs. <contact@nomadic-labs.com>               *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

(* The head of the list is the root of the namespace *)
type t = string list

type cons = string -> t

let sep = '/'

let root_name = "."

let empty = []

let is_empty = List.is_empty

let is_singleton = function [_] -> true | _ -> false

let to_string t =
  match t with [] -> root_name | _ -> String.concat (Char.escaped sep) t

let basename = function [] -> root_name | t -> Stdlib.List.(rev t |> hd)

let pp fmt t = Format.pp_print_string fmt (to_string t)

let pp_short fmt t = Format.pp_print_string fmt (basename t)

let equal = List.equal String.equal

let compare = List.compare String.compare

let hash = Stdlib.Hashtbl.hash

let of_string s =
  (if String.equal s root_name then [] else String.split_on_char sep s)
  |> List.rev
  |> (function
       | h :: t as l -> if String.(equal h empty) then t else l | [] -> [])
  |> List.rev

let append : t -> t -> t = List.append

let ( @ ) = append

let cons (l : t) (a : string) : t =
  l
  @
  match of_string a with
  | [_] -> [a]
  | _ ->
      Format.eprintf "Namespace.cons error: string contains %c: %s@." sep a ;
      assert false

let encoding = Data_encoding.(list string)

let to_list l = root_name :: l

let of_list l =
  let l = match l with x :: xs when x = root_name -> xs | _ -> l in
  match List.find (fun s -> String.contains s sep) l with
  | None -> l
  | Some a ->
      Format.eprintf
        "Namespace.of_list error: list contains \"%s\" that contains '%c'@."
        a
        sep ;
      assert false

let name_match (pattern : t) (name : t) =
  let l, leftovers = List.combine_with_leftovers pattern name in
  match leftovers with
  | None | Some (Right _) -> List.for_all (fun (a, b) -> String.equal a b) l
  | _ -> false

let to_filename ns =
  String.concat "__"
  @@
  match to_list ns with
  | hd :: ns when String.equal hd root_name -> ns
  | ns -> ns

module Hashtbl = Hashtbl.MakeSeeded (struct
  type nonrec t = t

  let equal = equal

  (* See [src/lib_base/tzPervasives.ml] for an explanation *)
  [@@@ocaml.warning "-32"]

  let hash = Hashtbl.seeded_hash

  let seeded_hash = Hashtbl.seeded_hash

  [@@@ocaml.warning "+32"]
end)

module Set = Set.Make (struct
  type nonrec t = t

  let compare = compare
end)

module Map = Map.Make (struct
  type nonrec t = t

  let compare = compare
end)

let root = cons []

let make ns str = cons (ns str)