package base

  1. Overview
  2. Docs
Full standard library replacement for OCaml

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (19)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

base-v0.16.0.tar.gz
sha256=ae7076435fb2b4e92b0a6a831ee76a2869b924a47d89ba3d5fc771aa8f54f66d

Description

Full standard library replacement for OCaml

Base is a complete and portable alternative to the OCaml standard library. It provides all standard functionalities one would expect from a language standard library. It uses consistent conventions across all of its module.

Base aims to be usable in any context. As a result system dependent features such as I/O are not offered by Base. They are instead provided by companion libraries such as stdio:

https://github.com/janestreet/stdio

Published: 31 May 2023

README

README.org

* Base

[[https://github.com/janestreet/base/actions][https://github.com/janestreet/base/actions/workflows/workflow.yml/badge.svg]]

Base is a standard library for OCaml. It provides a standard set of
general purpose modules that are well-tested, performant, and
fully-portable across any environment that can run OCaml code. Unlike
other standard library projects, Base is meant to be used as a
wholesale replacement of the standard library distributed with the
OCaml compiler. In particular it makes different choices and doesn't
re-export features that are not fully portable such as I/O, which are
left to other libraries.

You also might want to browse the [[https://ocaml.janestreet.com/ocaml-core/latest/doc/base/index.html][API Documentation]].

** Installation

Install Base via [[https://opam.ocaml.org][OPAM]]:

#+begin_src
$ opam install base
#+end_src

Base has no runtime dependencies and is fast to build. Its sole build
dependencies are [[https://github.com/ocaml/dune][dune]], which itself requires nothing more than the
compiler, and [[https://github.com/janestreet/sexplib0][sexplib0]].

** Using the OCaml standard library with Base

Base is intended as a full stdlib replacement.  As a result, after an
=open Base=, all the modules, values, types, ... coming from the OCaml
standard library that one normally gets in the default environment are
deprecated.

In order to access these values, one must use the =Stdlib= library,
which re-exports them all through the toplevel name =Stdlib=:
=Stdlib.String=, =Stdlib.print_string=, ...

** Differences between Base and the OCaml standard library

Programmers who are used to the OCaml standard library should read
through this section to understand major differences between the two
libraries that one should be aware of when switching to Base.

*** Comparison operators

The comparison operators exposed by the OCaml standard library are
polymorphic:

#+begin_src ocaml
val compare : 'a -> 'a -> int
val ( <= ) : 'a -> 'a -> bool
...
#+end_src

What they implement is structural comparison of the runtime
representation of values. Since these are often error-prone,
i.e. they don't correspond to what the user expects, they are not
exposed directly by Base.

To use polymorphic comparison with Base, one should use the =Poly=
module. The default comparison operators exposed by Base are the
integer ones, just like the default arithmetic operators are the
integer ones.

The recommended way to compare arbitrary complex data structures is to
use the specific =compare= functions. For instance:

#+begin_src ocaml
List.compare String.compare x y
#+end_src

The [[https://github.com/janestreet/ppx_compare][ppx_compare]] rewriter
offers an alternative way to write this:

#+begin_src ocaml
[%compare: string list] x y
#+end_src

** Base and ppx code generators

Base uses a few ppx code generators to implement:

- reliable and customizable comparison of OCaml values
- reliable and customizable hash of OCaml values
- conversions between OCaml values and s-expression

However, it doesn't need these code generators to build. What it does
instead is use ppx as a code verification tool during development. It
works in a very similar fashion to
[[https://github.com/janestreet/ppx_expect][expectation tests]].

Whenever you see this in the code source:

#+begin_src ocaml
type t = ... [@@deriving_inline sexp_of]
let sexp_of_t = ...
[@@@end]
#+end_src

the code between the =[@@deriving_inline]= and the =[@@@end]= is
generated code. The generated code is currently quite big and hard to
read, however we are working on making it look like human-written
code.

You can put the following elisp code in your =~/.emacs= file to hide
these blocks:

#+begin_src scheme
(defun deriving-inline-forward-sexp (&optional arg)
  (search-forward-regexp "\\[@@@end\\]") nil nil arg)

(defun setup-hide-deriving-inline ()
  (inline)
  (hs-minor-mode t)
  (let ((hs-hide-comments-when-hiding-all nil))
    (hs-hide-all)))

(require 'hideshow)
(add-to-list 'hs-special-modes-alist
             '(tuareg-mode "\\[@@deriving_inline[^]]*\\]" "\\[@@@end\\]" nil
                           deriving-inline-forward-sexp nil))
(add-hook 'tuareg-mode-hook 'setup-hide-deriving-inline)
#+end_src

Things are not yet setup in the git repository to make it convenient
to change types and update the generated code, but they will be setup
soon.

** Base coding rules

There are a few coding rules across the code base that are enforced by
lint tools.

These rules are:

- Opening the =Stdlib= module is not allowed. Inside Base, the OCaml
  stdlib is shadowed and accessible through the =Stdlib= module. We
  forbid opening =Stdlib= so that we know exactly where things come
  from.
- =Stdlib.Foo= modules cannot be aliased, one must use =Stdlib.Foo=
  explicitly. This is to avoid having to remember a list of aliases
  at the beginning of each file.
- For some modules that are both in the OCaml stdlib and Base, such as
  =String=, we define a module =String0= for common functions that
  cannot be defined directly in =Base.String= to avoid creating a
  circular dependency.  Except for =String= itself, other modules
  are not allowed to use =Stdlib.String= and must use either =String= or
  =String0= instead.
- Indentation is exactly the one of =ocp-indent=.
- A few other coding style rules enforced by
  [[https://github.com/janestreet/ppx_js_style][ppx_js_style]].

The Base specific coding rules are checked by =ppx_base_lint=, in the
=lint= subfolder. The indentation rules are checked by a wrapper around
=ocp-indent= and the coding style rules are checked by =ppx_js_style=.

These checks are currently not run by =dune=, but it will soon get a
=-dev= flag to run them automatically.

** Sexp (de-)serializers

Most types in Base have ~sexp_of_t~ and ~t_of_sexp~ functions for converting
between values of that type and their sexp representations.

One pair of functions deserves special attention: ~String.sexp_of_t~ and
~String.t_of_sexp~.  These functions have the same types as ~Sexp.of_string~ and
~Sexp.to_string~ but very different behavior.

~String.sexp_of_t~ and ~String.t_of_sexp~ are used to encode and decode strings
"embedded" in a sexp representation. On the other hand, ~Sexp.of_string~ and
~Sexp.to_string~ are used to encode and decode the textual form of
s-expressions.

The following example demonstrates the two pairs of functions in action:

#+begin_src ocaml
  open! Base
  open! Stdio

  (* Embed a string in a sexp *)

  let example_sexp : Sexp.t = List.sexp_of_t String.sexp_of_t [ "hello"; "world" ]

  let () =
    assert (Sexp.equal example_sexp (Sexp.List [ Sexp.Atom "hello"; Sexp.Atom "world" ]))
  ;;

  let () =
    assert (
      List.equal
        String.equal
        [ "hello"; "world" ]
        (List.t_of_sexp String.t_of_sexp example_sexp))
  ;;

  (* Embed a sexp in text (string) *)

  let write_sexp_to_file sexp =
    Out_channel.write_all "/tmp/file" ~data:(Sexp.to_string example_sexp)
  ;;

  (* /tmp/file now contains:

     {v
       (hello world)
     v} *)

  let () =
    assert (Sexp.equal example_sexp (Sexp.of_string (In_channel.read_all "/tmp/file")))
  ;;
#+end_src

Dependencies (5)

  1. conf-bash
  2. dune-configurator
  3. dune >= "2.0.0"
  4. sexplib0 >= "v0.16" & < "v0.17"
  5. ocaml >= "4.14.0"

Dev Dependencies

None

  1. abstract_algebra = "v0.16.0"
  2. accessor = "v0.16.0"
  3. accessor_base = "v0.16.0"
  4. ahrocksdb < "0.2.1"
  5. alcotest-async
  6. arrayjit < "0.4.1"
  7. async_ssl >= "v0.16.0" & < "v0.17.0"
  8. aws-s3 >= "4.4.0" & < "4.8.1"
  9. azblob
  10. bap-main
  11. bap-recipe
  12. bap-recipe-command
  13. bap-relation
  14. base_bigstring = "v0.16.0"
  15. base_quickcheck = "v0.16.0"
  16. base_trie < "v0.17.0"
  17. bin_prot = "v0.16.0"
  18. bio_io >= "0.2.1"
  19. bitvec-order
  20. bonsai = "v0.16.0"
  21. caisar
  22. caisar-ir
  23. caisar-nnet
  24. caisar-onnx
  25. caisar-ovo
  26. caisar-xgboost
  27. camelsnakekebab
  28. camlimages >= "5.0.3"
  29. capnp >= "3.3.0"
  30. catt
  31. cohttp-async = "2.5.2-1" | >= "5.2.0" & != "6.0.0"
  32. combinat < "3.0"
  33. cookie >= "0.1.8"
  34. core >= "v0.16.0" & < "v0.17.0"
  35. core_kernel = "v0.16.0"
  36. crlibm < "0.3"
  37. cucumber
  38. dedent < "v0.17.0"
  39. dotenv
  40. echo
  41. expect_test_helpers_core = "v0.16.0"
  42. FPauth
  43. FPauth-core
  44. FPauth-responses
  45. FPauth-strategies
  46. farith
  47. feather >= "0.2.0"
  48. feather_async
  49. fftw3 < "0.8.2"
  50. fieldslib = "v0.16.0"
  51. flow_parser < "0.246.0"
  52. fontforge-of-ocaml
  53. freetds = "0.6"
  54. GT >= "0.4.0" & < "0.5.2"
  55. gammu >= "0.9.4"
  56. genspio >= "0.0.3"
  57. gobject-introspection
  58. gsl >= "1.22.0" & < "1.24.3"
  59. h1_parser
  60. hacl
  61. hardcaml = "v0.16.0"
  62. hardcaml_axi < "v0.17.0"
  63. hardcaml_circuits = "v0.16.0"
  64. hardcaml_fixed_point = "v0.16.0"
  65. hardcaml_handshake < "v0.17.0"
  66. hardcaml_of_verilog = "v0.16.0"
  67. hardcaml_step_testbench = "v0.16.0"
  68. hardcaml_verify = "v0.16.0"
  69. hardcaml_waveterm = "v0.16.0"
  70. hardcaml_xilinx = "v0.16.0"
  71. hardcaml_xilinx_components = "v0.16.0"
  72. hardcaml_xilinx_reports < "v0.17.0"
  73. higher_kinded = "v0.16.0"
  74. idd
  75. idds
  76. influxdb
  77. influxdb-async
  78. influxdb-lwt
  79. inquire < "0.2.0"
  80. int_repr = "v0.16.0"
  81. jane_rope < "v0.17.0"
  82. jsonaf = "v0.16.0"
  83. jst-config = "v0.16.0"
  84. krb >= "v0.16.0"
  85. lacaml >= "10.0.1" & < "11.0.7"
  86. lbfgs < "0.9.1"
  87. learn-ocaml
  88. learn-ocaml-client
  89. libsvm >= "0.9.4"
  90. lilac
  91. liquid_interpreter
  92. liquid_ml
  93. liquid_parser
  94. liquid_std
  95. liquid_syntax
  96. logical
  97. matplotlib
  98. merge-fmt
  99. mesh-triangle >= "0.9.3" & < "0.9.5"
  100. mmdb >= "0.3.0"
  101. monorobot
  102. n_ary < "v0.17.0"
  103. neural_nets_lib < "0.4.1"
  104. non_empty_list
  105. numeric_string < "v0.17.0"
  106. nuscr
  107. OCanren-ppx
  108. obeam >= "0.1.0"
  109. ocaml-lsp-server >= "1.18.0"
  110. ocaml-r
  111. ocamlformat >= "0.14.3" & < "0.20.0" | >= "0.21.0" & < "0.25.1"
  112. ocamlformat-lib
  113. ocamlformat-mlx-lib
  114. ocamlformat-rpc < "0.20.0"
  115. ocamlmig
  116. opine
  117. ordinal_abbreviation < "v0.17.0"
  118. owl
  119. parsexp_io = "v0.16.0"
  120. patience_diff = "v0.16.0"
  121. pcre >= "7.3.0" & < "7.4.6"
  122. posixat = "v0.16.0"
  123. postgresql >= "4.1.0" & < "4.6.2"
  124. ppx-owl-opt
  125. ppx_accessor >= "v0.16.0" & < "v0.17.0"
  126. ppx_assert = "v0.16.0"
  127. ppx_bin_prot = "v0.16.0"
  128. ppx_cold = "v0.16.0"
  129. ppx_compare = "v0.16.0"
  130. ppx_conv_func = "v0.16.0"
  131. ppx_csv_conv = "v0.16.0"
  132. ppx_custom_printf = "v0.16.0"
  133. ppx_derive_at_runtime < "v0.17.0"
  134. ppx_deriving_cad
  135. ppx_deriving_hardcaml >= "v0.16.0"
  136. ppx_deriving_scad
  137. ppx_disable_unused_warnings = "v0.16.0"
  138. ppx_enumerate = "v0.16.0"
  139. ppx_expect >= "v0.16.0" & < "v0.17.0"
  140. ppx_fields_conv = "v0.16.0"
  141. ppx_fixed_literal = "v0.16.0"
  142. ppx_globalize < "v0.17.0"
  143. ppx_hash = "v0.16.0"
  144. ppx_here = "v0.16.0"
  145. ppx_inline_test >= "v0.16.0" & < "v0.17.0"
  146. ppx_js_style = "v0.16.0"
  147. ppx_jsonaf_conv = "v0.16.0"
  148. ppx_let = "v0.16.0"
  149. ppx_log = "v0.16.0"
  150. ppx_mica
  151. ppx_module_timer = "v0.16.0"
  152. ppx_open
  153. ppx_optcomp = "v0.16.0"
  154. ppx_optional = "v0.16.0"
  155. ppx_partial
  156. ppx_pattern_bind = "v0.16.0"
  157. ppx_protocol_conv >= "5.1.2"
  158. ppx_python = "v0.16.0"
  159. ppx_rapper >= "1.0.1"
  160. ppx_sexp_conv = "v0.16.0"
  161. ppx_sexp_message = "v0.16.0"
  162. ppx_sexp_value = "v0.16.0"
  163. ppx_stable = "v0.16.0"
  164. ppx_stable_witness < "v0.17.0"
  165. ppx_string = "v0.16.0"
  166. ppx_tydi < "v0.17.0"
  167. ppx_typed_fields = "v0.16.0"
  168. ppx_typerep_conv = "v0.16.0"
  169. ppx_variants_conv = "v0.16.0"
  170. ppx_xml_conv = "v0.16.0"
  171. ppx_yojson_conv = "v0.16.0"
  172. ppxlib != "0.14.0" & < "0.28.0"
  173. profunctor = "v0.16.0"
  174. protocell
  175. psyche
  176. pyml_bindgen < "0.4.1"
  177. pyre-ast
  178. pythonlib >= "v0.16.0"
  179. qinap
  180. range >= "0.6"
  181. re_parser < "v0.17.0"
  182. record_builder = "v0.16.0"
  183. regex_parser_intf < "v0.17.0"
  184. reparse = "2.1.0"
  185. routes >= "2.0.0"
  186. SZXX >= "4.1.0"
  187. safemoney >= "0.2.0"
  188. saltoIL
  189. sanddb
  190. secp256k1 >= "0.2.5"
  191. session-cookie
  192. session-cookie-lwt
  193. sexp_pretty = "v0.16.0"
  194. sexp_select = "v0.16.0"
  195. speed
  196. spin < "0.8.0"
  197. splittable_random = "v0.16.0"
  198. sqlite3 >= "4.2.0" & < "5.0.1"
  199. stdio = "v0.16.0"
  200. streamable < "v0.17.0"
  201. string_dict = "v0.16.0"
  202. swipl
  203. tablecloth-base >= "0.0.10"
  204. tablecloth-native < "0.0.8"
  205. tdigest = "2.2.0"
  206. tensorboard
  207. tensorflow
  208. tilde_f < "v0.17.0"
  209. time_now = "v0.16.0"
  210. timmy
  211. timmy-unix >= "1.1.5"
  212. topological_sort = "v0.16.0"
  213. torch < "v0.17.0"
  214. tqdm
  215. twostep
  216. typed_list
  217. typerep = "v0.16.0"
  218. user-agent-parser
  219. variantslib = "v0.16.0"
  220. virtual_dom = "v0.16.0"
  221. wasmtime
  222. wseg
  223. zanuda
  224. zmq-async
  225. zmq-eio
  226. zmq-lwt < "5.1.0"

Conflicts

None

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