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

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.13.2.tar.gz
md5=f43ce18d98fd0879e77ff671e077e607

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: 11 May 2020

README

README.org

* Base

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 =Caml= library,
which re-exports them all through the toplevel name =Caml=:
=Caml.String=, =Caml.print_string=, ...

The recommended way to build code using Base is as follows:

#+begin_src ocaml
$ ocamlc -open Base
#+end_src

** 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
=Polymorphic_compare= 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 =Caml= module is not allowed. Inside Base, the OCaml
  stdlib is shadowed and accessible through the =Caml= module. We
  forbid opening =Caml= so that we know exactly where things come
  from.
- =Caml.Foo= modules cannot be aliased, one must use =Caml.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 =Caml.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.

** Roadmap

Following is the current plan for a stable version 1 of Base.

*** Add more integer types

Add support for ={,u}int{8,16,32,64}=. These are always useful when
implementing binary protocols.

Initially they should be implemented with C stubs and eventually we
should propose their inclusion in the compiler.

*** 80 columns limit

Currently lines in Base are limited to a maximum width of 90
characters. To make things more standard, we should use an 80 columns
limit.  The only thing needed for this is to extend the style checker
to enforce a maximum line width.

*** Improve the generated code

Improve our code generators to produce code that looks more like
hand-written code.

Dependencies (4)

  1. dune-configurator
  2. dune >= "1.5.1"
  3. sexplib0 >= "v0.13" & < "v0.14"
  4. ocaml >= "4.04.2" & < "4.12"

Dev Dependencies

None

  1. ahrocksdb < "0.2.1"
  2. alcotest-async >= "1.3.0"
  3. async_ssl = "v0.13.0"
  4. azblob
  5. bap-main
  6. bap-recipe
  7. bap-recipe-command
  8. bap-relation
  9. base_bigstring = "v0.13.0"
  10. base_quickcheck = "v0.13.0"
  11. bin_prot = "v0.13.0"
  12. bio_io >= "0.2.1" & < "0.5.1"
  13. bitvec-order
  14. camelsnakekebab
  15. camlimages >= "5.0.3"
  16. capnp >= "3.3.0"
  17. cohttp-async >= "2.5.0" & != "5.3.0" & < "6.0.0~alpha2"
  18. combinat < "3.0"
  19. configurator >= "v0.11.0"
  20. cookie >= "0.1.8"
  21. core_kernel >= "v0.13.0" & < "v0.14.0"
  22. crlibm < "0.3"
  23. dataframe
  24. dotenv
  25. expect_test_helpers_kernel >= "v0.13.0"
  26. FPauth
  27. FPauth-core
  28. FPauth-responses
  29. FPauth-strategies
  30. farith
  31. feather_async < "0.2.0"
  32. fftw3 >= "0.8" & < "0.8.2"
  33. fieldslib = "v0.13.0"
  34. fontforge-of-ocaml
  35. freetds = "0.6"
  36. GT >= "0.4.0" & < "0.5.2"
  37. gammu >= "0.9.4"
  38. genspio >= "0.0.3"
  39. gobject-introspection
  40. gsl >= "1.22.0" & < "1.24.3"
  41. h1_parser
  42. hacl
  43. hardcaml = "v0.13.0"
  44. hardcaml_waveterm = "v0.13.0"
  45. idd
  46. idds
  47. influxdb
  48. influxdb-async
  49. influxdb-lwt
  50. inquire < "0.2.0"
  51. json-derivers
  52. jst-config = "v0.13.0"
  53. lacaml >= "10.0.1" & < "11.0.7"
  54. lbfgs = "0.9"
  55. learn-ocaml >= "0.12"
  56. learn-ocaml-client
  57. libsvm >= "0.9.4"
  58. lilac
  59. liquid_interpreter >= "0.1.2"
  60. liquid_ml >= "0.1.2"
  61. liquid_parser >= "0.1.2"
  62. liquid_std >= "0.1.2"
  63. liquid_syntax >= "0.1.2"
  64. logical
  65. matplotlib
  66. merge-fmt
  67. mesh-triangle >= "0.9.3" & < "0.9.5"
  68. mmdb
  69. monorobot
  70. netkat
  71. notty_async < "v0.12.0"
  72. nsq >= "0.2.5"
  73. nuscr
  74. OCanren-ppx >= "0.3.0~alpha1"
  75. obeam >= "0.1.0"
  76. ocaml-logicalform
  77. ocaml-protoc-plugin < "1.0.0"
  78. ocaml-r >= "0.1.0" & < "0.3.1"
  79. ocamlformat >= "0.9" & < "0.25.1"
  80. ocamlformat-lib
  81. ocamlformat-rpc < "0.21.0"
  82. opine
  83. owl >= "0.3.7"
  84. pa_ppx = "0.03"
  85. parsexp = "v0.13.0"
  86. parsexp_io = "v0.13.0"
  87. patience_diff = "v0.13.0"
  88. pcre >= "7.3.0" & < "7.4.6"
  89. posixat = "v0.13.0"
  90. postgresql >= "4.1.0" & < "4.6.2"
  91. ppx-owl-opt
  92. ppx_assert = "v0.13.0"
  93. ppx_bin_prot = "v0.13.0"
  94. ppx_cold < "v0.14.0"
  95. ppx_compare = "v0.13.0"
  96. ppx_conv_func = "v0.13.0"
  97. ppx_csv_conv = "v0.13.0"
  98. ppx_custom_printf = "v0.13.0"
  99. ppx_deriving_cad >= "0.2.0"
  100. ppx_deriving_hardcaml = "v0.13.0"
  101. ppx_deriving_protocol < "0.8.1"
  102. ppx_deriving_rpc = "7.2.0"
  103. ppx_deriving_scad
  104. ppx_enumerate = "v0.13.0"
  105. ppx_expect >= "v0.13.0" & < "v0.14.0"
  106. ppx_fail = "v0.13.0"
  107. ppx_fields_conv = "v0.13.0"
  108. ppx_hash = "v0.13.0"
  109. ppx_here = "v0.13.0"
  110. ppx_inline_test >= "v0.13.0" & < "v0.14.0"
  111. ppx_js_style = "v0.13.0"
  112. ppx_let = "v0.13.0"
  113. ppx_module_timer = "v0.13.0"
  114. ppx_optcomp = "v0.13.0"
  115. ppx_optional = "v0.13.0"
  116. ppx_pattern_bind = "v0.13.1"
  117. ppx_protocol_conv >= "2.0.0" & != "4.0.0" & < "5.1.2"
  118. ppx_protocol_conv_json < "3.1.0"
  119. ppx_protocol_conv_msgpack < "3.1.0"
  120. ppx_protocol_conv_xml_light < "3.1.0"
  121. ppx_protocol_conv_yaml < "3.1.0"
  122. ppx_python = "v0.13.0"
  123. ppx_rapper >= "1.0.1"
  124. ppx_sexp_conv = "v0.13.0"
  125. ppx_sexp_message = "v0.13.0"
  126. ppx_sexp_value = "v0.13.0"
  127. ppx_stable = "v0.13.0"
  128. ppx_typerep_conv = "v0.13.0"
  129. ppx_variants_conv = "v0.13.0"
  130. ppx_xml_conv = "v0.13.0"
  131. ppx_yojson_conv = "v0.13.0"
  132. ppxlib < "0.30.0"
  133. protocell
  134. psyche
  135. pyml_bindgen
  136. pythonlib = "v0.13.0"
  137. qinap
  138. range >= "0.6"
  139. reason-standard
  140. record_builder = "v0.13.0"
  141. reparse = "2.1.0"
  142. routes >= "2.0.0"
  143. sanddb
  144. secp256k1 >= "0.2.5"
  145. session-cookie
  146. session-cookie-lwt
  147. sexp_pretty = "v0.13.0"
  148. sexp_select < "v0.14.0"
  149. shexp = "v0.13.0"
  150. sihl < "0.1.5"
  151. socialpeek
  152. spin < "0.8.0"
  153. splittable_random = "v0.13.0"
  154. sqlite3 >= "4.2.0" & < "5.0.1"
  155. stdio = "v0.13.0"
  156. string_dict = "v0.13.0"
  157. tablecloth-base
  158. tablecloth-native < "transition"
  159. tensorboard
  160. tensorflow >= "0.0.11"
  161. time_now = "v0.13.0"
  162. timmy
  163. topological_sort = "v0.13.0"
  164. torch < "v0.16.0"
  165. tqdm
  166. travesty >= "0.6.0" & < "0.7.2"
  167. twostep
  168. typerep = "v0.13.0"
  169. user-agent-parser
  170. variantslib = "v0.13.0"
  171. vcaml < "v0.14.0"
  172. virtual_dom = "v0.13.0"
  173. wasmtime
  174. wseg
  175. zanuda
  176. zmq-async
  177. zmq-eio
  178. zmq-lwt < "5.1.0"

Conflicts

None