Module Tezos_micheline.Micheline

type annot = string list
type ('l, 'p) node =
| Int of 'l * Z.t
| String of 'l * string
| Bytes of 'l * Stdlib.Bytes.t
| Prim of 'l * 'p * ( 'l, 'p ) node list * annot
| Seq of 'l * ( 'l, 'p ) node list

The abstract syntax tree of Micheline expressions. The first parameter is used to contain locations, but can also embed custom data. The second parameter is the type of primitive names.

val location : ( 'l, 'p ) node -> 'l

Extract the location of the node.

val annotations : ( 'l, 'p ) node -> string list

Extract the annotations of the node.

type 'p canonical

Expression form using canonical integer numbering as locations. The root has number zero, and each node adds one in the order of infix traversal. To be used when locations are not important, or when one wants to attach properties to nodes in an expression without rewriting it (using an indirection table with canonical locations as keys).

type canonical_location = int

Canonical integer locations that appear inside canonical expressions.

val dummy_location : canonical_location

A location that won't exist in any well-formed canonical value

val strip_locations : ( _, 'p ) node -> 'p canonical

Compute the canonical form of an expression. Drops the concrete locations completely.

val root : 'p canonical -> ( canonical_location, 'p ) node

Give the root node of an expression in canonical form.

val extract_locations : ( 'l, 'p ) node -> 'p canonical * (canonical_location * 'l) list

Compute the canonical form of an expression. Saves the concrete locations in an association list.

val inject_locations : ( canonical_location -> 'l ) -> 'p canonical -> ( 'l, 'p ) node

Transforms an expression in canonical form into a polymorphic one. Takes a mapping function to inject the concrete locations.

val map : ( 'a -> 'b ) -> 'a canonical -> 'b canonical

Copies the tree, updating its primitives.

val map_node : ( 'la -> 'lb ) -> ( 'pa -> 'pb ) -> ( 'la, 'pa ) node -> ( 'lb, 'pb ) node

Copies the tree, updating its primitives and locations.