package bap-std

  1. Overview
  2. Docs
The Binary Analysis Platform Standard Library

Install 

dune-project
 Dependency

github.com Edit opam file Versions (5)

Authors

  1. B
    BAP Team

Maintainers

  1. I
    Ivan Gotovchits <ivg@ieee.org>

Sources

v2.2.0.tar.gz
sha256=7c6d0dfe2640e800829617dd150ffe748493fe3f317ed41be44312b2821deb46
md5=5dbc6677d646bec59fd7414f23e88cf8

doc/bap/Bap/Std/Project/Collator/index.html

Module Project.Collator

A pass that collates projects.

A collator is a pass that is folded over projects and computes differences between the base version and the number of alternative versions.

  • since 2.2.0
type t
type info

Information about a collator.

val register : ?desc:string -> ?package:string -> string -> prepare:(project -> 's) -> collate:(int -> 's -> project -> 's) -> summary:('s -> unit) -> unit

register ~prepare ~collate ~summary name registers a collator.

The prepare function is called on the base version and it returns the collator's state that can be an arbitrary type 's. Then the collate function is consequitevely applied on alternative versions of the base version, with the version number passed as the first argument (starting from 0). Finally, when all versions are compared with the base, the summary function is called.

The collator fullname (package:name) must be unique, otherwise a function terminates.

val apply : t -> project seq -> unit

apply collator projects applies the collator to the sequence of projects.

Projects are evaluated lazily, one project at time.

val find : ?package:string -> string -> t option

find ?package name looks up a collator in the registry.

the collators name

val desc : info -> string

the collators description.

val registered : unit -> info list

information about currently registered collators