package ocplib-endian

  1. Overview
  2. Docs

Source file endianBigstring.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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
# 1 "endianBigstring.cppo.ml"
(************************************************************************)
(*  ocplib-endian                                                       *)
(*                                                                      *)
(*    Copyright 2012 OCamlPro                                           *)
(*                                                                      *)
(*  This file is distributed under the terms of the GNU Lesser General  *)
(*  Public License as published by the Free Software Foundation; either *)
(*  version 2.1 of the License, or (at your option) any later version,  *)
(*  with the OCaml static compilation exception.                        *)
(*                                                                      *)
(*  ocplib-endian is distributed in the hope that it will be useful,    *)
(*  but WITHOUT ANY WARRANTY; without even the implied warranty of      *)
(*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the       *)
(*  GNU General Public License for more details.                        *)
(*                                                                      *)
(************************************************************************)

open Bigarray

type bigstring = (char, int8_unsigned_elt, c_layout) Array1.t

module type EndianBigstringSig = sig
  (** Functions reading according to Big Endian byte order *)

  val get_char : bigstring -> int -> char
  (** [get_char buff i] reads 1 byte at offset i as a char *)

  val get_uint8 : bigstring -> int -> int
  (** [get_uint8 buff i] reads 1 byte at offset i as an unsigned int of 8
  bits. i.e. It returns a value between 0 and 2^8-1 *)

  val get_int8 : bigstring -> int -> int
  (** [get_int8 buff i] reads 1 byte at offset i as a signed int of 8
  bits. i.e. It returns a value between -2^7 and 2^7-1 *)

  val get_uint16 : bigstring -> int -> int
  (** [get_uint16 buff i] reads 2 bytes at offset i as an unsigned int
  of 16 bits. i.e. It returns a value between 0 and 2^16-1 *)

  val get_int16 : bigstring -> int -> int
  (** [get_int16 buff i] reads 2 byte at offset i as a signed int of
  16 bits. i.e. It returns a value between -2^15 and 2^15-1 *)

  val get_int32 : bigstring -> int -> int32
  (** [get_int32 buff i] reads 4 bytes at offset i as an int32. *)

  val get_int64 : bigstring -> int -> int64
  (** [get_int64 buff i] reads 8 bytes at offset i as an int64. *)

  val get_float : bigstring -> int -> float
  (** [get_float buff i] is equivalent to
      [Int32.float_of_bits (get_int32 buff i)] *)

  val get_double : bigstring -> int -> float
  (** [get_double buff i] is equivalent to
      [Int64.float_of_bits (get_int64 buff i)] *)

  val set_char : bigstring -> int -> char -> unit
  (** [set_char buff i v] writes [v] to [buff] at offset [i] *)

  val set_int8 : bigstring -> int -> int -> unit
  (** [set_int8 buff i v] writes the least significant 8 bits of [v]
  to [buff] at offset [i] *)

  val set_int16 : bigstring -> int -> int -> unit
  (** [set_int16 buff i v] writes the least significant 16 bits of [v]
  to [buff] at offset [i] *)

  val set_int32 : bigstring -> int -> int32 -> unit
  (** [set_int32 buff i v] writes [v] to [buff] at offset [i] *)

  val set_int64 : bigstring -> int -> int64 -> unit
  (** [set_int64 buff i v] writes [v] to [buff] at offset [i] *)

  val set_float : bigstring -> int -> float -> unit
  (** [set_float buff i v] is equivalent to
      [set_int32 buff i (Int32.bits_of_float v)] *)

  val set_double : bigstring -> int -> float -> unit
  (** [set_double buff i v] is equivalent to
      [set_int64 buff i (Int64.bits_of_float v)] *)

end

let get_char (s:bigstring) off =
  Array1.get s off
  [@@ocaml.inline]
let set_char (s:bigstring) off v =
  Array1.set s off v
  [@@ocaml.inline]
let unsafe_get_char (s:bigstring) off =
  Array1.unsafe_get s off
  [@@ocaml.inline]
let unsafe_set_char (s:bigstring) off v =
  Array1.unsafe_set s off v
  [@@ocaml.inline]

# 1 "common.ml"
[@@@warning "-32"]

let sign8 v =
  (v lsl ( Sys.int_size - 8 )) asr ( Sys.int_size - 8 )
  [@@ocaml.inline]

let sign16 v =
  (v lsl ( Sys.int_size - 16 )) asr ( Sys.int_size - 16 )
  [@@ocaml.inline]

let get_uint8 s off =
  Char.code (get_char s off)
  [@@ocaml.inline]
let get_int8 s off =
  ((get_uint8 s off) lsl ( Sys.int_size - 8 )) asr ( Sys.int_size - 8 )
  [@@ocaml.inline]
let set_int8 s off v =
  (* It is ok to cast using unsafe_chr because both String.set
     and Bigarray.Array1.set (on bigstrings) use the 'store unsigned int8'
     primitives that effectively extract the bits before writing *)
  set_char s off (Char.unsafe_chr v)
  [@@ocaml.inline]

let unsafe_get_uint8 s off =
  Char.code (unsafe_get_char s off)
  [@@ocaml.inline]
let unsafe_get_int8 s off =
  ((unsafe_get_uint8 s off) lsl ( Sys.int_size - 8 )) asr ( Sys.int_size - 8 )
  [@@ocaml.inline]
let unsafe_set_int8 s off v =
  unsafe_set_char s off (Char.unsafe_chr v)
  [@@ocaml.inline]

# 100 "endianBigstring.cppo.ml"
external unsafe_get_16 : bigstring -> int -> int = "%caml_bigstring_get16u"
external unsafe_get_32 : bigstring -> int -> int32 = "%caml_bigstring_get32u"
external unsafe_get_64 : bigstring -> int -> int64 = "%caml_bigstring_get64u"

external unsafe_set_16 : bigstring -> int -> int -> unit = "%caml_bigstring_set16u"
external unsafe_set_32 : bigstring -> int -> int32 -> unit = "%caml_bigstring_set32u"
external unsafe_set_64 : bigstring -> int -> int64 -> unit = "%caml_bigstring_set64u"

external get_16 : bigstring -> int -> int = "%caml_bigstring_get16"
external get_32 : bigstring -> int -> int32 = "%caml_bigstring_get32"
external get_64 : bigstring -> int -> int64 = "%caml_bigstring_get64"

external set_16 : bigstring -> int -> int -> unit = "%caml_bigstring_set16"
external set_32 : bigstring -> int -> int32 -> unit = "%caml_bigstring_set32"
external set_64 : bigstring -> int -> int64 -> unit = "%caml_bigstring_set64"


# 1 "common_401.cppo.ml"
# 1 "common_401.cppo.ml"
external swap16 : int -> int = "%bswap16"
external swap32 : int32 -> int32 = "%bswap_int32"
external swap64 : int64 -> int64 = "%bswap_int64"
external swapnative : nativeint -> nativeint = "%bswap_native"

module BigEndian = struct

  let get_char = get_char
  let get_uint8 = get_uint8
  let get_int8 = get_int8
  let set_char = set_char
  let set_int8 = set_int8

  

# 1 "be_ocaml_401.ml"
  
# 1 "be_ocaml_401.ml"
  let get_uint16 s off =
    if not Sys.big_endian
    then swap16 (get_16 s off)
    else get_16 s off
  [@@ocaml.inline]

  let get_int16 s off =
   ((get_uint16 s off) lsl ( Sys.int_size - 16 )) asr ( Sys.int_size - 16 )
  [@@ocaml.inline]

  let get_int32 s off =
    if not Sys.big_endian
    then swap32 (get_32 s off)
    else get_32 s off
  [@@ocaml.inline]

  let get_int64 s off =
    if not Sys.big_endian
    then swap64 (get_64 s off)
    else get_64 s off
  [@@ocaml.inline]

  let set_int16 s off v =
    if not Sys.big_endian
    then (set_16 s off (swap16 v))
    else set_16 s off v
  [@@ocaml.inline]

  let set_int32 s off v =
    if not Sys.big_endian
    then set_32 s off (swap32 v)
    else set_32 s off v
  [@@ocaml.inline]

  let set_int64 s off v =
    if not Sys.big_endian
    then set_64 s off (swap64 v)
    else set_64 s off v
  [@@ocaml.inline]


# 2 "common_float.ml"
# 2 "common_float.ml"
let get_float buff i = Int32.float_of_bits (get_int32 buff i) [@@ocaml.inline]
let get_double buff i = Int64.float_of_bits (get_int64 buff i) [@@ocaml.inline]
let set_float buff i v = set_int32 buff i (Int32.bits_of_float v) [@@ocaml.inline]
let set_double buff i v = set_int64 buff i (Int64.bits_of_float v) [@@ocaml.inline]


# 17 "common_401.cppo.ml"
# 17 "common_401.cppo.ml"
end

module BigEndian_unsafe = struct

  let get_char = unsafe_get_char
  let get_uint8 = unsafe_get_uint8
  let get_int8 = unsafe_get_int8
  let set_char = unsafe_set_char
  let set_int8 = unsafe_set_int8
  let get_16 = unsafe_get_16
  let get_32 = unsafe_get_32
  let get_64 = unsafe_get_64
  let set_16 = unsafe_set_16
  let set_32 = unsafe_set_32
  let set_64 = unsafe_set_64

  

# 1 "be_ocaml_401.ml"
  
# 1 "be_ocaml_401.ml"
  let get_uint16 s off =
    if not Sys.big_endian
    then swap16 (get_16 s off)
    else get_16 s off
  [@@ocaml.inline]

  let get_int16 s off =
   ((get_uint16 s off) lsl ( Sys.int_size - 16 )) asr ( Sys.int_size - 16 )
  [@@ocaml.inline]

  let get_int32 s off =
    if not Sys.big_endian
    then swap32 (get_32 s off)
    else get_32 s off
  [@@ocaml.inline]

  let get_int64 s off =
    if not Sys.big_endian
    then swap64 (get_64 s off)
    else get_64 s off
  [@@ocaml.inline]

  let set_int16 s off v =
    if not Sys.big_endian
    then (set_16 s off (swap16 v))
    else set_16 s off v
  [@@ocaml.inline]

  let set_int32 s off v =
    if not Sys.big_endian
    then set_32 s off (swap32 v)
    else set_32 s off v
  [@@ocaml.inline]

  let set_int64 s off v =
    if not Sys.big_endian
    then set_64 s off (swap64 v)
    else set_64 s off v
  [@@ocaml.inline]


# 2 "common_float.ml"
# 2 "common_float.ml"
let get_float buff i = Int32.float_of_bits (get_int32 buff i) [@@ocaml.inline]
let get_double buff i = Int64.float_of_bits (get_int64 buff i) [@@ocaml.inline]
let set_float buff i v = set_int32 buff i (Int32.bits_of_float v) [@@ocaml.inline]
let set_double buff i v = set_int64 buff i (Int64.bits_of_float v) [@@ocaml.inline]


# 36 "common_401.cppo.ml"
# 36 "common_401.cppo.ml"
end

module LittleEndian = struct

  let get_char = get_char
  let get_uint8 = get_uint8
  let get_int8 = get_int8
  let set_char = set_char
  let set_int8 = set_int8

  

# 1 "le_ocaml_401.ml"
  
# 1 "le_ocaml_401.ml"
  let get_uint16 s off =
    if Sys.big_endian
    then swap16 (get_16 s off)
    else get_16 s off
  [@@ocaml.inline]

  let get_int16 s off =
   ((get_uint16 s off) lsl ( Sys.int_size - 16 )) asr ( Sys.int_size - 16 )
  [@@ocaml.inline]

  let get_int32 s off =
    if Sys.big_endian
    then swap32 (get_32 s off)
    else get_32 s off
  [@@ocaml.inline]

  let get_int64 s off =
    if Sys.big_endian
    then swap64 (get_64 s off)
    else get_64 s off
  [@@ocaml.inline]

  let set_int16 s off v =
    if Sys.big_endian
    then (set_16 s off (swap16 v))
    else set_16 s off v
  [@@ocaml.inline]

  let set_int32 s off v =
    if Sys.big_endian
    then set_32 s off (swap32 v)
    else set_32 s off v
  [@@ocaml.inline]

  let set_int64 s off v =
    if Sys.big_endian
    then set_64 s off (swap64 v)
    else set_64 s off v
  [@@ocaml.inline]


# 2 "common_float.ml"
# 2 "common_float.ml"
let get_float buff i = Int32.float_of_bits (get_int32 buff i) [@@ocaml.inline]
let get_double buff i = Int64.float_of_bits (get_int64 buff i) [@@ocaml.inline]
let set_float buff i v = set_int32 buff i (Int32.bits_of_float v) [@@ocaml.inline]
let set_double buff i v = set_int64 buff i (Int64.bits_of_float v) [@@ocaml.inline]


# 49 "common_401.cppo.ml"
# 49 "common_401.cppo.ml"
end

module LittleEndian_unsafe = struct

  let get_char = unsafe_get_char
  let get_uint8 = unsafe_get_uint8
  let get_int8 = unsafe_get_int8
  let set_char = unsafe_set_char
  let set_int8 = unsafe_set_int8
  let get_16 = unsafe_get_16
  let get_32 = unsafe_get_32
  let get_64 = unsafe_get_64
  let set_16 = unsafe_set_16
  let set_32 = unsafe_set_32
  let set_64 = unsafe_set_64

  

# 1 "le_ocaml_401.ml"
  
# 1 "le_ocaml_401.ml"
  let get_uint16 s off =
    if Sys.big_endian
    then swap16 (get_16 s off)
    else get_16 s off
  [@@ocaml.inline]

  let get_int16 s off =
   ((get_uint16 s off) lsl ( Sys.int_size - 16 )) asr ( Sys.int_size - 16 )
  [@@ocaml.inline]

  let get_int32 s off =
    if Sys.big_endian
    then swap32 (get_32 s off)
    else get_32 s off
  [@@ocaml.inline]

  let get_int64 s off =
    if Sys.big_endian
    then swap64 (get_64 s off)
    else get_64 s off
  [@@ocaml.inline]

  let set_int16 s off v =
    if Sys.big_endian
    then (set_16 s off (swap16 v))
    else set_16 s off v
  [@@ocaml.inline]

  let set_int32 s off v =
    if Sys.big_endian
    then set_32 s off (swap32 v)
    else set_32 s off v
  [@@ocaml.inline]

  let set_int64 s off v =
    if Sys.big_endian
    then set_64 s off (swap64 v)
    else set_64 s off v
  [@@ocaml.inline]


# 2 "common_float.ml"
# 2 "common_float.ml"
let get_float buff i = Int32.float_of_bits (get_int32 buff i) [@@ocaml.inline]
let get_double buff i = Int64.float_of_bits (get_int64 buff i) [@@ocaml.inline]
let set_float buff i v = set_int32 buff i (Int32.bits_of_float v) [@@ocaml.inline]
let set_double buff i v = set_int64 buff i (Int64.bits_of_float v) [@@ocaml.inline]


# 68 "common_401.cppo.ml"
# 68 "common_401.cppo.ml"
end

module NativeEndian = struct

  let get_char = get_char
  let get_uint8 = get_uint8
  let get_int8 = get_int8
  let set_char = set_char
  let set_int8 = set_int8

  

# 1 "ne_ocaml_401.ml"
  
# 1 "ne_ocaml_401.ml"
  let get_uint16 s off =
    get_16 s off
  [@@ocaml.inline]

  let get_int16 s off =
   ((get_uint16 s off) lsl ( Sys.int_size - 16 )) asr ( Sys.int_size - 16 )
  [@@ocaml.inline]

  let get_int32 s off =
    get_32 s off
  [@@ocaml.inline]

  let get_int64 s off =
    get_64 s off
  [@@ocaml.inline]

  let set_int16 s off v =
    set_16 s off v
  [@@ocaml.inline]

  let set_int32 s off v =
    set_32 s off v
  [@@ocaml.inline]

  let set_int64 s off v =
    set_64 s off v
  [@@ocaml.inline]


# 2 "common_float.ml"
# 2 "common_float.ml"
let get_float buff i = Int32.float_of_bits (get_int32 buff i) [@@ocaml.inline]
let get_double buff i = Int64.float_of_bits (get_int64 buff i) [@@ocaml.inline]
let set_float buff i v = set_int32 buff i (Int32.bits_of_float v) [@@ocaml.inline]
let set_double buff i v = set_int64 buff i (Int64.bits_of_float v) [@@ocaml.inline]


# 81 "common_401.cppo.ml"
# 81 "common_401.cppo.ml"
end

module NativeEndian_unsafe = struct

  let get_char = unsafe_get_char
  let get_uint8 = unsafe_get_uint8
  let get_int8 = unsafe_get_int8
  let set_char = unsafe_set_char
  let set_int8 = unsafe_set_int8
  let get_16 = unsafe_get_16
  let get_32 = unsafe_get_32
  let get_64 = unsafe_get_64
  let set_16 = unsafe_set_16
  let set_32 = unsafe_set_32
  let set_64 = unsafe_set_64

  

# 1 "ne_ocaml_401.ml"
  
# 1 "ne_ocaml_401.ml"
  let get_uint16 s off =
    get_16 s off
  [@@ocaml.inline]

  let get_int16 s off =
   ((get_uint16 s off) lsl ( Sys.int_size - 16 )) asr ( Sys.int_size - 16 )
  [@@ocaml.inline]

  let get_int32 s off =
    get_32 s off
  [@@ocaml.inline]

  let get_int64 s off =
    get_64 s off
  [@@ocaml.inline]

  let set_int16 s off v =
    set_16 s off v
  [@@ocaml.inline]

  let set_int32 s off v =
    set_32 s off v
  [@@ocaml.inline]

  let set_int64 s off v =
    set_64 s off v
  [@@ocaml.inline]


# 2 "common_float.ml"
# 2 "common_float.ml"
let get_float buff i = Int32.float_of_bits (get_int32 buff i) [@@ocaml.inline]
let get_double buff i = Int64.float_of_bits (get_int64 buff i) [@@ocaml.inline]
let set_float buff i v = set_int32 buff i (Int32.bits_of_float v) [@@ocaml.inline]
let set_double buff i v = set_int64 buff i (Int64.bits_of_float v) [@@ocaml.inline]


# 100 "common_401.cppo.ml"
# 100 "common_401.cppo.ml"
end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct