package kappa-library

  1. Overview
  2. Docs
On This Page
  1. I/O
package kappa-library
Legend:
Library
Module
Module type
Parameter
Class
Class type

Module for type Loc.t annotating structured data with the line range * in a file which was used to define it

type position = {
  1. chr : int;
  2. line : int;
}
type t = {
  1. file : string;
  2. from_position : position;
  3. to_position : position;
}
type 'a annoted = 'a * t
val v : 'a annoted -> 'a

Extract value from Loc.annoted

val get_annot : 'a annoted -> t

Extract annotation from Loc.annoted

val copy_annot : 'b annoted -> 'a -> 'a annoted

Create annoted variable with same annotation as existing variable

val map_annot : ('a -> 'b) -> 'a annoted -> 'b annoted

Apply operation on variable and keep annotation

val of_pos : Lexing.position -> Lexing.position -> t
val dummy : t
val annot_with_dummy : 'a -> 'a annoted
val is_annoted_with_dummy : 'a annoted -> bool
val merge : t -> t -> t

merge b e creates the range from beginning of b to the end of e (filename must match)

val is_included_in : string -> position -> t -> bool

I/O

val to_string : t -> string
val print : Format.formatter -> t -> unit
val print_annoted : (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a annoted -> unit
val annoted_of_yojson : ?filenames:string array -> (Yojson.Basic.t -> 'a) -> Yojson.Basic.t -> 'a annoted
val yojson_of_annoted : ?filenames:int Kappa_data_structures.Mods.StringMap.t -> ('a -> Yojson.Basic.t) -> 'a annoted -> Yojson.Basic.t
val write_position : Buffer.t -> position -> unit
val write_range : Buffer.t -> t -> unit

Output a JSON value of type t.

val string_of_range : ?len:int -> t -> string

Serialize a value of type t into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

val read_range : Yojson.Safe.lexer_state -> Lexing.lexbuf -> t

Input JSON data of type t.

val range_of_string : string -> t

Deserialize JSON data of type t.

Annoted yojson helpers

val string_annoted_to_json : filenames:int Kappa_data_structures.Mods.StringMap.t -> string annoted -> Yojson.Basic.t
val string_annoted_of_json : filenames:string array -> Yojson.Basic.t -> string annoted
val string_option_annoted_to_json : filenames:int Kappa_data_structures.Mods.StringMap.t -> string option annoted -> Yojson.Basic.t
val string_option_annoted_of_json : filenames:string array -> Yojson.Basic.t -> string option annoted
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct