package sexplib
Library for serializing OCaml values to and from S-expressions
Install
Dune Dependency
Authors
Maintainers
Sources
v0.9.1.tar.gz
sha256=4cfea2edbe90db2227409abc5e93e86ee4413c8c7aeeb73f2fd69a86a7d55766
md5=2e820b5de70ba33883c936cd7af317fb
Description
Part of Jane Street's Core library The Core suite of libraries is an industrial strength alternative to OCaml's standard library that was developed by Jane Street, the largest industrial user of OCaml.
Published: 28 Mar 2017
README
README.org
* Sexplib - S-Expressions for OCaml
=sexplib= contains functionality for parsing and pretty-printing
s-expressions. S-expressions are defined by the following type:
#+begin_src ocaml
type sexp = Atom of string | List of sexp list
#+end_src
and are rendered as parenthesized lists of strings, /e.g./ =(This (is
an) (s expression))=.
This library is often used in conjunction with =ppx_sexp_conv=, a
syntax extension which generates code from type definitions for
efficiently converting OCaml-values to s-expressions and vice versa.
Together, these two libraries make it easy and convenient to convert
your OCaml values to and from a human-readable serializable form,
without the tedium of having to write your own converters.
The library also offers functionality for extracting and replacing
sub-expressions in s-expressions. Here, we'll only document =sexplib=
proper. If you want to know more about the way in which OCaml types
are mapped on to s-expressions, you should look at the documentation
for =ppx_sexp_conv=.
** Lexical conventions of s-expression
Whitespace, which consists of space, newline, horizontal tab, and form
feed, is ignored unless within an OCaml-string, where it is treated
according to OCaml-conventions. The left parenthesis opens a new
list, the right one closes it again. Lists can be empty. The double
quote denotes the beginning and end of a string following the lexical
conventions of OCaml (see the [[http://www.ocaml.org/pub/docs/manual-ocaml][OCaml-manual]] for details). All
characters other than double quotes, left- and right parentheses,
whitespace, carriage return, and comment-introducing characters or
sequences (see next paragraph) are considered part of a contiguous
string.
** Comments
There are three kinds of comments:
- _line comments_ are introduced with =;=, and end at the newline.
- _sexp comments_ are introduced with =#;=, and end at the end of the
following s-expression
- _block comments_ are introduced with =#|= and end with =|#=. These
can be nested, and double-quotes within them must be balanced and be
lexically correct OCaml strings.
** Grammar of s-expressions
s-expressions are either strings (= atoms) or lists. The lists can
recursively contain further s-expressions or be empty, and must be
balanced, /i.e./ parentheses must match.
** Examples
#+begin_src scheme
this_is_an_atom_123'&^%! ; this is a comment
"another atom in an OCaml-string \"string in a string\" \123"
; empty list follows below
()
; a more complex example
(
(
list in a list ; comment within a list
(list in a list in a list)
42 is the answer to all questions
#; (this S-expression
(has been commented out)
)
#| Block comments #| can be "nested" |# |#
)
)
#+end_src
** I/O and Type Conversions
There are multiple ways of performing I/O with s-expressions. If
exact error locations are required when type conversions fail,
s-expressions need to be parsed with location annotations. The
associated parser is slower, however, and needs more memory. In most
cases users may therefore want to use functions like =load_sexp_conv=
or =load_sexp_conv_exn=, which load s-expressions from files and
convert them. They initially read the file without location
annotations for performance reasons. Only if conversions fail, the
file will be reparsed with location annotations. Type errors can then
be reported accurately with file name, line number, column, and file
position.
** Custom converters
In addition to the converters provided automatically by
=ppx_sexp_conv=, it's possible to write one's own sexp-converter. For
such converters to be available by other automatically generated
converters, it should follow the convention of being defined in the
same scope as the type, and should be named =sexp_of_[type]= and
=[type_of_sexp]=.
You must report failures by raising the =Of_sexp_error=-exception so
that then =sexplib='s tools for pinpointing the location of type
errors within an s-expression file will work properly.
Dev Dependencies
None
- amf
-
arakoon
= "1.9.0" -
async-zmq
>= "0.3.0" -
async_core
< "108.00.02" -
async_parallel
= "v0.9.0" -
awa
< "0.2.0" -
base
>= "v0.9.1" & < "v0.9.4" -
bin_prot
>= "v0.9.0" & < "v0.9.2" - biocaml
-
bistro
>= "0.2.0" & != "0.4.0" -
bookaml
>= "3.1" -
camlhighlight
>= "4.0" - cconv-ppx
- charrua
-
charrua-core
>= "0.3" - charrua-server
-
cohttp
>= "0.20.0" & < "1.2.0" -
cohttp-async
= "1.1.1" -
cohttp-lwt
= "1.1.1" -
cohttp-mirage
< "2.0.0" -
conduit
>= "0.12.0" & != "3.0.0" & < "7.0.0" -
conduit-async
>= "1.2.0" & != "3.0.0" & < "7.0.0" -
conduit-lwt
>= "1.3.0" & != "3.0.0" & < "7.0.0" -
conduit-mirage
!= "3.0.0" & < "7.0.0" -
coq-serapi
< "8.9.0+0.6.0" -
core
>= "v0.9.0" & < "v0.9.2" -
core_extended
= "v0.9.0" -
core_kernel
= "v0.9.0" -
cstruct
>= "1.8.0" & < "4.0.0" - cstruct-sexp
-
csvfields
< "v0.9.1" -
datakit-server
< "0.11.0" - datakit-server-9p
- decoders-sexplib
-
diet
< "0.4" - dns-forward
-
dockerfile
>= "1.3.0" -
dockerfile-cmd
>= "8.1.0" -
dockerfile-opam
= "4.0.0" | >= "7.1.0" - dune-compiledb
- dune-deps
- dune-expand
- erlang
-
ezjsonm
>= "0.4.0" & < "1.2.0" - ezjsonm-lwt
-
frenetic
>= "5.0.0" & < "5.0.5" -
git
< "1.1.0" -
git-http
>= "1.11.4" & < "2.1.0" -
graphql
< "0.4.0" -
graphql_parser
< "0.9.0" - hack_parallel
-
ipaddr
>= "2.7.0" & < "3.0.0" -
irmin-unix
>= "3.0.0" & < "3.2.0" -
jekyll-format
>= "0.3.0" -
jenga
= "v0.9.0" -
ketrew
= "3.0.0" -
lazy-trie
>= "1.2.0" - mecab
-
message-switch
>= "1.4.0" -
mirage
= "3.0.0" -
mirage-conduit
= "1.3.0" | >= "3.1.0" -
mirage-crypto-pk
< "0.10.4" -
mirage-http
>= "2.5.0" & < "2.5.3" - mirage-net-macosx
-
mirage-net-xen
>= "1.6.0" & < "1.7.1" -
mirage-tc
>= "0.2.0" & < "0.3.0" -
msgpck
< "1.1" -
nbd
>= "2.1.0" - netchannel
-
nocrypto
>= "0.5.3" - obuilder
- obuilder-spec
- ocaml-basics
- ocaml-indent
-
ocaml-topexpect
>= "0.3" -
ocaml_plugin
= "v0.9.0" - odep
-
odoc
>= "1.4.0" & < "2.0.0" -
opass
>= "1.0.6" - open_packaging
- opine
-
opium
>= "0.14.0" & < "0.16.0" - opium_kernel
-
otr
>= "0.3.1" & < "0.3.6" -
pa_ppx
= "0.03" -
patdiff
= "v0.9.0" -
pgocaml
>= "4.2" -
pgocaml_ppx
>= "4.2" & < "4.3.0" -
planck
>= "2.2.0" -
posixat
< "v0.9.1" -
ppx_assert
= "v0.9.0" -
ppx_cstruct
>= "4.0.0" -
ppx_meta_conv
= "2.0.2" | = "2.5.0" -
ppx_protocol_conv
>= "3.1.0" -
ppx_protocol_conv_json
>= "3.1.0" - ppx_protocol_conv_jsonm
-
ppx_protocol_conv_msgpack
>= "3.1.0" -
ppx_protocol_conv_xml_light
>= "3.1.0" - ppx_protocol_conv_xmlm
-
ppx_protocol_conv_yaml
>= "3.1.0" -
ppx_sexp_conv
= "v0.9.0" -
ppx_sexp_message
= "v0.9.0" -
ppx_sexp_value
= "v0.9.0" -
protocol-9p
>= "0.6.0" - protocol-9p-unix
- qcow
-
qcow-format
>= "0.3" - qcow-tool
-
rpc_parallel
= "v0.9.0" -
sexp_pretty
< "v0.10.0" -
shared-block-ring
>= "2.3.0" -
sihl
< "0.1.0" -
ssh-agent
< "0.4.0" - sslconf
-
timedesc
= "0.8.0" - timmy
-
tls
>= "0.7.1" & < "0.17.0" -
tlstunnel
>= "0.1.2" -
torch
< "v0.16.0" -
typerep_extended
>= "v0.9.0" -
uri
>= "1.9.2" & < "2.0.0" -
vchan
>= "2.1.0" & < "6.0.2" -
vchan-unix
< "6.0.2" -
vchan-xen
< "6.0.2" -
vmnet
>= "1.1.0" - vscoq-language-server
-
wamp
= "1.0" -
websocket-lwt-unix
>= "2.17" -
x509
>= "0.5.1" & < "0.7.0" -
xapi-backtrace
< "0.7" -
yaml
>= "0.2.0" & < "3.0.0" - yaml-sexp
- yices2_bindings
- zanuda