package memgraph

  1. Overview
  2. Docs
A small library to inspect memory representation of ocaml values

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (1)

Authors

  1. G
    Guillaume Bury <guillaume.bury@gmail.com>
  2. A
    Armaël Guéneau <armael.gueneau@ens-lyon.org>

Maintainers

  1. G
    Guillaume Bury <guillaume.bury@gmail.com>
  2. A
    Armaël Guéneau <armael.gueneau@ens-lyon.org>

Sources

memgraph-1.0.tbz
sha256=5e53bb092d0a5f8c025a7b17118c068c7d998cf47f459e9d634fdd26dc84af26
sha512=407382d1fb7de266983949f57d4ff882a4666b5cfea8845a75c67d397f055d9b00c9a2d4aff5ce7f3c2d198f1a4a8a921ff0ac5cd10c82a5a75b471e9b900a43

doc/memgraph/Memgraph/Dot/index.html

Module Memgraph.DotSource

Dot output

This module provides some helper to print the memory representation of ocaml values as graphviz graphs.

Settings

Sourcetype config

The config type gathers tweakable settings of the graphviz output. See the config function below for constructing values of type config.

Sourceval config : ?external_node_color:string option -> ?block_node_color:string option -> ?root_node_color:string option -> ?outline_color:string -> ?background_color:string option -> ?direction:[ `Vertical | `Horizontal ] -> unit -> config

Build a value of type config, provided some of the following (all optional) settings. (For colors provided as a string option, the None value corresponds to transparency.)

  • external_node_color: the fill color of nodes for out-of-heap pointers (default: Some "grey");
  • block_node_color: the fill color of standard block nodes (default: Some "lightblue");
  • root_node_color: the fill color of root notes (default: Some "yellow");
  • outline_color: the color of the outlines of nodes, edges, and text (default: "black");
  • background_color: the color of the background (default: None);
  • direction: whether to lay out successive nodes from top to bottow (`Vertical) or left to right (`Horizontal) (default: `Vertical).

Dot Printing functions

Sourceval print_list : ?conf:config -> Format.formatter -> (string * [ `Direct ] Repr.cell) list -> unit

Print a list of reprs on the given formatter.

Sourceval to_file : ?conf:config -> string -> (string * [ `Direct ] Repr.cell) list -> unit

Print a list of reprs in the given file (the file must not exist and will be created by this function)