package fmlib

  1. Overview
  2. Docs

Description

Umbrella for a collection of libraries supporting functional programming with managed effects. The umbrella contains only documentation. See the following packages to get the functionality:

  • fmlib_std: A lot of standard data types.

  • fmlib_parse: Monadic parsing functions with combinators suitable for incremental and indentation sensitive parsing.

  • fmlib_pretty: Pretty printing functions. Prints hierachical structures like expressions and indented paragraphs nicely.

  • fmlib_js: Interface to javscript via js_of_ocaml.

Published: 01 Feb 2023

README

Fmlib - Functional Library with Managed Effects for Ocaml

Overview

Fmlib is a functional library which has components for

  • Standard Data Structures (B trees, ... ): Fmlib_std

  • Pretty Printing: Fmlib_pretty

  • Parsing: Fmlib_parse

  • Access to the browser and nodejs: Fmlib_js.

API Documentation

Design Documentation: Some designs and the corresponding algorithms are documented separately to ensure correctness of the corresponding designs and algorithms. The design documention is not neccessary to understand the usage of the library from a user's perspective. The user's perspective is documented in the API.

Installation

It is best to install the libraries via the ocaml package manager opam.

opam install fmlib_std
opam install fmlib_pretty
opam install fmlib_parse
opam install fmlib_js

Usage with dune

A program foo which uses e.g. the library fmlib_std can be e.g. compiled by dune with the dune file

(executable
    (name foo)
    (libraries
        fmlib_std
        ...
    )
)

Dependencies (6)

  1. fmlib_js = version
  2. fmlib_parse = version
  3. fmlib_pretty = version
  4. fmlib_std = version
  5. dune >= "1.10"
  6. ocaml >= "4.08.0"

Dev Dependencies (1)

  1. odoc with-doc

Used by

None

Conflicts

None