package core

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file std_internal.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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
(* We don't just include Sexplib.Std because one can only define Hashtbl once in this
   module. *)

open! Import

(** [include]d first so that everything else shadows it *)
include Core_pervasives

include Int.Replace_polymorphic_compare
include Base_quickcheck.Export
include Deprecate_pipe_bang
include Either.Export
include From_sexplib
include Interfaces
include List.Infix
include Never_returns
include Ordering.Export
include Perms.Export
include Result.Export

type -'a return = 'a With_return.return = private { return : 'b. 'a -> 'b } [@@unboxed]

include struct
  exception Bug of string [@deprecated "[since 2020-03] Don't use [Bug]"]
  [@@deriving sexp]
end [@@alert "-deprecated"]


(** Raised if malloc in C bindings fail (errno * size). *)
exception C_malloc_exn of int * int

(* errno, size *)
let () = Callback.register_exception "C_malloc_exn" (C_malloc_exn (0, 0))

exception Finally = Exn.Finally

let fst3 (x, _, _) = x
let snd3 (_, y, _) = y
let trd3 (_, _, z) = z

include (
struct
  let uw = function
    | Some x -> x
    | None ->
      raise Caml.Not_found
  ;;
end :
sig
  val uw : 'a option -> 'a [@@deprecated "[since 2018-12] Use [Option.value_exn]"]
end)

(** [phys_same] is like [phys_equal], but with a more general type.  [phys_same] is useful
    when dealing with existential types, when one has a packed value and an unpacked value
    that one wants to check are physically equal.  One can't use [phys_equal] in such a
    situation because the types are different. *)
let phys_same (type a b) (a : a) (b : b) = phys_equal a (Obj.magic b : a)

let ( % ) = Int.( % )
let ( /% ) = Int.( /% )
let ( // ) = Int.( // )
let ( ==> ) a b = (not a) || b
let bprintf = Printf.bprintf
let const = Fn.const
let eprintf = Printf.eprintf
let error = Or_error.error
let error_s = Or_error.error_s
let failwithf = Base.Printf.failwithf

include (
struct
  let failwithp = (Error.failwithp [@alert "-deprecated"])
end :
sig
  val failwithp
    :  ?strict:unit
    -> Source_code_position.t
    -> string
    -> 'a
    -> ('a -> Sexp.t)
    -> _
  [@@deprecated "[since 2020-03] Use [failwiths] instead."]
end)

let failwiths = Error.failwiths
let force = Base.Lazy.force
let fprintf = Printf.fprintf

include (
struct
  let ident = Fn.id
end :
sig
  val ident : 'a -> 'a [@@deprecated "[since 2021-08] Use [Fn.id] instead."]
end)

let invalid_argf = Base.Printf.invalid_argf
let ifprintf = Printf.ifprintf
let is_none = Option.is_none
let is_some = Option.is_some
let ksprintf = Printf.ksprintf
let ok_exn = Or_error.ok_exn
let phys_equal = Base.phys_equal
let phys_same = phys_same
let print_s = Stdio.print_s
let eprint_s = Stdio.eprint_s
let printf = Printf.printf
let protect = Exn.protect
let protectx = Exn.protectx
let raise_s = Error.raise_s
let round = Float.round
let ( **. ) = Base.( **. )
let ( %. ) = Base.( %. )

let sprintf = Printf.sprintf
let stage = Staged.stage
let unstage = Staged.unstage
let with_return = With_return.with_return
let with_return_option = With_return.with_return_option

(* With the following aliases, we are just making extra sure that the toplevel sexp
   converters line up with the ones in our modules. *)


include Typerep_lib.Std_internal

include (
struct
  (* [deriving hash] is missing for [array], [bytes], and [ref] since these types are
     mutable. *)
  type 'a array = 'a Array.t
  [@@deriving bin_io, compare, equal, sexp, sexp_grammar, typerep]

  type bool = Bool.t
  [@@deriving bin_io, compare, hash, equal, sexp, sexp_grammar, typerep]

  type char = Char.t
  [@@deriving bin_io, compare, hash, equal, sexp, sexp_grammar, typerep]

  type float = Float.t
  [@@deriving bin_io, compare, hash, equal, sexp, sexp_grammar, typerep]

  type int = Int.t
  [@@deriving bin_io, compare, hash, equal, sexp, sexp_grammar, typerep]

  type int32 = Int32.t
  [@@deriving bin_io, compare, hash, equal, sexp, sexp_grammar, typerep]

  type int64 = Int64.t
  [@@deriving bin_io, compare, hash, equal, sexp, sexp_grammar, typerep]

  type 'a lazy_t = 'a Lazy.t
  [@@deriving bin_io, compare, hash, sexp, sexp_grammar, typerep]

  type 'a list = 'a List.t
  [@@deriving bin_io, compare, hash, equal, sexp, sexp_grammar, typerep]

  type nativeint = Nativeint.t
  [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]

  type 'a option = 'a Option.t
  [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]

  type string = String.t
  [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]

  type bytes = Bytes.t [@@deriving bin_io, compare, equal, sexp, sexp_grammar, typerep]

  type 'a ref = 'a Ref.t
  [@@deriving bin_io, compare, equal, sexp, sexp_grammar, typerep]

  type unit = Unit.t
  [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]

  (* Bin_prot has optimized functions for float arrays *)
  include struct
    type float_array = float array [@@deriving bin_io]
  end [@alert "-deprecated"]

  include (
  struct
    type float_array = Float.t array [@@deriving compare, sexp, sexp_grammar, typerep]
  end :
  sig
    type float_array [@@deriving compare, sexp, sexp_grammar, typerep]
  end
  with type float_array := float_array)
end :
sig
  type 'a array [@@deriving bin_io, compare, equal, sexp, sexp_grammar, typerep]
  type bool [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]
  type char [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]
  type float [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]
  type int [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]
  type int32 [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]
  type int64 [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]
  type 'a lazy_t [@@deriving bin_io, compare, hash, sexp, sexp_grammar, typerep]
  type 'a list [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]

  type nativeint
  [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]

  type 'a option
  [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]

  type string [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]
  type bytes [@@deriving bin_io, compare, equal, sexp, sexp_grammar, typerep]
  type 'a ref [@@deriving bin_io, compare, equal, sexp, sexp_grammar, typerep]
  type unit [@@deriving bin_io, compare, equal, hash, sexp, sexp_grammar, typerep]

  include sig
    type float_array = float array
    [@@deriving bin_io, compare, sexp, sexp_grammar, typerep]
    [@@deprecated "[since 2021-09] use [float array] or [floatarray] instead"]
  end
          [@alert "-deprecated"]
end
with type 'a array := 'a array
with type bool := bool
with type char := char
with type float := float
with type int := int
with type int32 := int32
with type int64 := int64
with type 'a list := 'a list
with type nativeint := nativeint
with type 'a option := 'a option
with type string := string
with type bytes := bytes
with type 'a lazy_t := 'a lazy_t
with type 'a ref := 'a ref
with type unit := unit)

let sexp_of_exn = Exn.sexp_of_t


(* The code below checks that the signatures in map.mli and set.mli are
   consistent with the generic map and set signatures defined in map_intf.ml
   and set_intf.ml. *)

let () =
  let module T = struct
    type 'a elt = 'a
    type 'a cmp = 'a
  end
  in
  let module _ : sig
    open Set_intf

    module Tree : sig
      type ('a, 'b) t

      include
        Creators_and_accessors2_with_comparator
        with type ('a, 'b) set := ('a, 'b) t
        with type ('a, 'b) t := ('a, 'b) t
        with type ('a, 'b) tree := ('a, 'b) t
        with type ('a, 'b) named := ('a, 'b) Tree.Named.t
    end

    type ('a, 'b) t

    include
      Accessors2
      with type ('a, 'b) t := ('a, 'b) t
      with type ('a, 'b) tree := ('a, 'b) Tree.t
      with type ('a, 'b) named := ('a, 'b) Named.t

    include
      Creators_generic
      with type ('a, 'b) set := ('a, 'b) t
      with type ('a, 'b) t := ('a, 'b) t
      with type ('a, 'b) tree := ('a, 'b) Tree.t
      with type 'a elt := 'a T.elt
      with type 'a cmp := 'a T.cmp
      with type ('a, 'cmp, 'z) options :=
        ('a, 'cmp, 'z) Set_intf.With_first_class_module.t
  end =
    Set
  in
  ()
;;

let () =
  let module T = struct
    type 'k key = 'k
    type 'c cmp = 'c
  end
  in
  let module _ : sig
    open Map_intf

    module Tree : sig
      type ('a, 'b, 'c) t

      include
        Creators_and_accessors3_with_comparator
        with type ('a, 'b, 'c) t := ('a, 'b, 'c) t
        with type ('a, 'b, 'c) tree := ('a, 'b, 'c) t
    end

    type ('a, 'b, 'c) t

    include
      Accessors3
      with type ('a, 'b, 'c) t := ('a, 'b, 'c) t
      with type ('a, 'b, 'c) tree := ('a, 'b, 'c) Tree.t

    include
      Creators_generic
      with type ('a, 'b, 'c) t := ('a, 'b, 'c) t
      with type ('a, 'b, 'c) tree := ('a, 'b, 'c) Tree.t
      with type ('a, 'cmp, 'z) options :=
        ('a, 'cmp, 'z) Map_intf.With_first_class_module.t
      with type 'k key := 'k T.key
      with type 'c cmp := 'c T.cmp
  end =
    Map
  in
  ()
;;

OCaml

Innovation. Community. Security.