package csexp

  1. Overview
  2. Docs
Parsing and printing of S-expressions in Canonical form

Install

Dune Dependency

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

Authors

  1. Q
    Quentin Hocquet <mefyl@gruntech.org>
  2. J
    Jane Street Group, LLC
  3. J
    Jeremie Dimino <jeremie@dimino.org>

Maintainers

  1. J
    Jeremie Dimino <jeremie@dimino.org>

Sources

csexp-1.2.2.tbz
sha256=cc5ce7a031d866770b5c8bbe447ef8fcdba71174f5f1718da8b02a29aebcd6a7
sha512=d06550920e61f91d811b735348142084b36eddcd1fe0524260e90602c0795cadbf7c8e2cc9a970704a30aece768e16474e55dbeca83ed5d7a775ced568c68b0f

Description

This library provides minimal support for Canonical S-expressions [1]. Canonical S-expressions are a binary encoding of S-expressions that is super simple and well suited for communication between programs.

This library only provides a few helpers for simple applications. If you need more advanced support, such as parsing from more fancy input sources, you should consider copying the code of this library given how simple parsing S-expressions in canonical form is.

To avoid a dependency on a particular S-expression library, the only module of this library is parameterised by the type of S-expressions.

[1] https://en.wikipedia.org/wiki/Canonical_S-expressions

Published: 24 Jun 2020

README

Csexp - Canonical S-expressions

This project provides minimal support for parsing and printing S-expressions in canonical form, which is a very simple and canonical binary encoding of S-expressions.

Example

# #require "csexp";;
# module Sexp = struct type t = Atom of string | List of t list end;;
module Sexp : sig type t = Atom of string | List of t list end
# module Csexp = Csexp.Make(Sexp);;
module Csexp :
  sig
    val parse_string : string -> (Sexp.t, int * string) result
    val parse_string_many : string -> (Sexp.t list, int * string) result
    val input : in_channel -> (Sexp.t, string) result
    val input_opt : in_channel -> (Sexp.t option, string) result
    val input_many : in_channel -> (Sexp.t list, string) result
    val serialised_length : Sexp.t -> int
    val to_string : Sexp.t -> string
    val to_buffer : Buffer.t -> Sexp.t -> unit
    val to_channel : out_channel -> Sexp.t -> unit
  end
# Csexp.to_string (List [ Atom "Hello"; Atom "world!" ]);;
- : string = "(5:Hello6:world!)"

Dependencies (3)

  1. result >= "1.5"
  2. ocaml >= "4.02.3"
  3. dune >= "2.5"

Dev Dependencies

None

Used by (5)

  1. containers >= "3.5"
  2. coq-of-ocaml >= "2.4.1" & < "2.5.3+4.14"
  3. dune-rpc
  4. lsp < "1.6.1"
  5. ocamlformat-rpc-lib < "0.21.0"

Conflicts

None