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 (27)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.16.3.tar.gz
md5=04572fc23a4651604cfcab83f720cb4c
sha512=69380ed392faf4495459f97f70a10a6959fce71d2e6ba093472fc272141646307fd7872407de855dfa48ef0435f6587eae5aa50f4a67eac40a9e1946d0c3c070

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