package orsetto
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=9b654edb663ae697563f150824047052f3b1bf760398f24bce6350553f031f73c46b6337239a1acd871e61238597ea92046809e3358290ff14d6ba671b449085
doc/orsetto.cf/Cf_annot/index.html
Module Cf_annot
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 Meta : sig ... endSubmodule comprising types for structured interchange of position data.
module type Basis = sig ... endThe basis signature for creating an annotation system.
module type Profile = sig ... endThe 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
and type Meta.fields := B.Meta.fieldsUse Create(B) to make an annotation system module for the symbols defined in B.
module Coded : sig ... endA submodule containing specializations for use with
module Textual : sig ... endA submodule containing specializations for textual representations.