package orsetto

  1. Overview
  2. Docs
package orsetto
Legend:
Library
Module
Module type
Parameter
Class
Class type

Position annotation systems.

Overview

This module defines an interface for composing systems that annotate scanned or decoded values with the span of positions in the input stream where the represented value was found. Specializations of position information are provided for streams analyzed with

f_decode

as well as streams comprising lines of text.

A distinguished module is provided for annotating streams comprising texts encoded in 8-bit ASCII.

Interface
module type Basis = sig ... end

The basis signature for creating an annotation system.

module type Profile = sig ... end

The signture of an annotation system specialized on a basis module.

module Create (B : Basis) : Profile with type symbol := B.Symbol.t and type position := B.Position.t

Use Create(B) to make an annotation system module for the symbols defined in B.

module Coded : sig ... end

A submodule containing specializations for use with

module Textual : sig ... end

A submodule containing specializations for textual representations.